API Endpoint
Request Body
The unique identifier for the agent to be used for the KYC job.
The KYC schema containing the individual’s information.
An optional URL to receive webhook notifications about the job status.
An optional Slack webhook URL to receive notifications about the job status.
An optional array of specific check IDs to run. If not provided, all checks will be run.
Optional. A unique identifier (UUID) that you can provide for this job.
If provided, this ID will be used as an idempotency key.
If a job with this ID already exists, the API will return a
409 Conflict
error, and you can then use this job_id
to retrieve the existing job’s status and results using /getJobById
.
If not provided, a new unique ID will be automatically generated for the job.Response
The status of the job creation request. Will be “ok” if successful.
The unique identifier for the created job.
A message indicating the result of the job creation request.
Details about the created job.
Example Request
Example Response
Successful creation (200 OK):job_id
already exists:
Authorizations
JWT token obtained from the authentication endpoint
Body
application/json