Q5id Proven Identity Implementation Guide

Low-Code Implementation for Fast, Easy Time to Market

Schedule Time With Our Team

Q5id’s low-code implementation makes integrating Q5id into your identity verification workflows simple and fast. Your customers will use the Q5id Proven Identity app to have their identity proven and enroll to get a Q5id Proven Identity.  This is a one-time process that takes less than 3 minutes.  Whenever you need to verify a person’s identity prior to a transaction, your app or platform can make a call to the Q5id authentication endpoints.

The consumer will receive a text notification on their phone with a message to verify their identity using the Q5id Proven Identity app. In just a few seconds, the consumer scans their biometrics using their phone and the Q5id API returns a pass/fail response back to your system.

Below is a diagram of how the authentication workflow works and the code needed to make a call and receive the result of an authentication.

Authentication Flow Diagram 

Example uses SMS Authentication to demonstrate a typical authentication request, challenge-response, and result.

Click to Enlarge

Q5id Authentication Flow

Customer hits a REST endpoint to initiate challenge-response 

POST https://<apim-url>/v1/customer/challenges
  Request Body: 
  "phoneNumber": "<string>",
  "programCode": "<string>"
  Response Body:
  "status": "<pass|fail|error|processing>",
  "statusUri": "<string>" 

Customer polls a REST endpoint <apim-url> + {StatusUri} for updated Challenge Record

GET https://<apim-url>/v1/customer/challenges/{challengeCode}
  Response Body:
  "authenticationResult": "<pass|fail|error|processing>",
  "accountUuid": "nullable<guid>" 

Customer system parses user Q5id GUID

Payload enclosed in a JSON Web Token (JWT)

Have questions on implementation?

Do you have a unique environment or use case? Questions about a more complex integration? Click the button below to set up time with our team: