We will explain how we can have an integrated JAAK KYC for APIBefore you start you have to have consulted the Section JAAK KYC and that a Short Key.
That diagram illustrates an identity check (KYC) integrated with API. Through an exchange of keys, you get a
BearerTokenauthorising and grouping calls by session KYC (shortKey). On the front, the components of JAAK SDK they are responsible for guiding the user for an optimum capture of his biometric documents and data, issuing the results in Base64 format. Finally, backend receives this information and orchestrates calls to products from JAAK (as OCR, Liveness and document monitoring).
Requirements
All phone calls API That we will conduct next will be through architecture REST (represented State Transfer) with the web standard HTTP (HyperText Transfer Protocol) and signing communication with format JSON (JavaScript Object Note).
We recommend that we have at least a basic knowledge of these 3 concepts so that we can continue with this guide.
Common headquarters
All the flow steps (step 1 to 9) share two heads that spread throughout the session:
| Leader | When to send him | Origin |
|---|---|---|
Authorization: Bearer <token> | Steps 1 and 2 with the API Key (JWT generated in the platform). Steps 3 to 9 with the Access Token returned in step 2. | API Key from the JAAK Platform; Access Token from the response of /v1/kyc/session. |
traceparent | Recommended at all steps from step 2. | Track 2 response head (W3C Track Context format). Resend it allows JAAK correlates all the services of the session KYC in login and metric. |
Keep traceparent consistent throughout the flow is key to enabling the support team to diagnose incidents by session without ambiguity. If you miss them, the calls will be processed as well but the logs will be fragmented.
URL
| Environment | Base URL |
|---|---|
| Sandbox | https://api.sandbox.jaak.ai/api |
| Production | https://services.api.jaak.ai/api |
All path (/v1/kyc/flow, /v1/kyc/session, /v3/document/verify, /v4/document/extract, /v2/blacklist/investigate, /v1/liveness/verify-and-bestframe, /v2/oto/verify, /v1/kyc/session/finish) are related to this basis.