API Reference

Initiate Kyc Verification

post
https://api-sandbox.urbanpayx.com/api/v1/kyc/verify

Initiate KYC verification

Creates the user if they don't already exist, registers them with the identity verification provider, and returns a verification link to send to the user. Only applicable to users in URBANPAYX_KYC verification mode.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The email of the user

string
required

The full name of the user

string
length between 1 and 64
Defaults to id-and-liveness

Verification level key from GET /api/v1/kyc/levels. The key must exist and be active; otherwise the request is rejected.

Responses

Updated 28 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago