Initializes KYC process and returns SDK link and qr-code

POST 
/v1/compliance/kyc

Initializes KYC for a customer, making initial validations and returning a link and a qr code that will take the customer to the SDK for uploading documentation and validating biometrics

Request

application/json

Body

required

customerId stringrequired

The ID of the customer in question

Responses

200

KYC started and is waiting for the customer to upload documents and selfie

application/json

Schema

Schema

traceId string
message string

data

object

onboardingId stringrequired

Id of the started onboarding

sdk

object

If your kyc includes the document and liveness capture sdk flow, this property will provide you the links for the integration

link stringrequired

sdk link

qr_code stringrequired

QR code in base64 that redirects user to sdk link

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "onboardingId": "string",
    "sdk": {
      "link": "https://example.com?entityId=123e4567-e89b-12d3-a456-426614174021&journeyId=123e4567-e89b-12d3-a456-426614174021",
      "qr_code": "qr-code-base-64"
    }
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...