Overview

This is a draft of the APIs for requesting a Proof of Passport from a mobile app. The system contains the following components:

• 3rd Party Mobile Apps and Backend: external system that integrates the Proof of Passport
• RariMe App: mobile app that generates the proofs
• verificator-svc: a service that incapsulates ZK proof verification. Self-hosted by the 3rd party.

Back End

Docs

https://rarimo.github.io/verificator-svc/

Interface

• Request verification for the user: https://rarimo.github.io/verificator-svc/#tag/User-verification/operation/getVerificationLink
• Check user status: https://rarimo.github.io/verificator-svc/#tag/User-verification/operation/getUserStatus
• Get user proof: https://rarimo.github.io/verificator-svc/#tag/User-verification/operation/getProof
• Delete user: https://rarimo.github.io/verificator-svc/#tag/User-verification/operation/deleteUser

Example

• Request verification for the user:

const backendUrl = '<https://api.example.com>'
const body = {
  data: {
	  type: "user",
    // External system user ID (public key)
    id: "some-user-id",
    attributes: {
      // Denotes the application and activity that is requesting the verification
      event_id: "my_app_verify_voter",
      // Minimum required age (including)
      age_lower_bound: 18,
      // Should check for uniqueness
      uniqueness: true,
      // ISO 3166 alpha-3 country code: <https://www.iban.com/country-codes>
      // Note: Germany passports may have single-letter "D" code
      nationality: "UKR"
    }
  }
}

const response = await fetch(
  `${backendUrl}/integrations/verificator-svc/private/verification-link`,
  {
    headers: {
      'Accept': 'application/vnd.api+json',
      'Content-Type': 'application/vnd.api+json',
    },
    method: "POST",
    body: JSON.stringify(body),
  }
)
const { data } = await response.json()
// Proof Params URL for RariMe app
const proofParamsUrl = data.attributes.get_proof_params

• Check user status:

const backendUrl = '<https://api.example.com>'
const userId = 'some-user-id'

const response = await fetch(`${backendUrl}/integrations/verification-svc/private/verification-status/${userId}`)
const { data } = await response.json()

// responseUserId === userId
const responseUserId = data.id

// Verification status enum:
// - "not_verified" - user is not verified
// - "verified" - user is verified
// - "failed_verification" - user verification failed
// - "uniqueness_check_failed" - user uniqueness check failed
const verificationStatus = data.attributes.status

iOS