API reference
verkyc API operations
The reference is built from the OpenAPI contract of the same version that runs on the server. Every operation lists its method, path, key scopes, parameters, request body and responses.
Contract version1.1.0OpenAPI 3.1.1
How requests work
Requests carry an API key in the Authorization: Bearer header. A key has an environment (test or live) and scopes.
Create and change operations require an Idempotency-Key header of 16 to 128 characters.
Errors are returned as application/problem+json with a machine code and a retry flag.
Starting a verification
Processing contexts
The purpose, basis and region in which applicants and cases are created.
Operations: 1Applicants
The individuals and companies you verify.
Operations: 4Cases
Applicant verification: creation, submission, sessions, links, checks, ownership graph, reports and decisions.
Operations: 32Verification links
Managing links to the verification page.
Operations: 1Sessions
Applicant sessions in the widget and the app.
Operations: 1
Results and reports
Checks
Individual checks of a case with outcomes, reasons and evidence.
Operations: 3Decisions
Policy decisions on a case and the risk assessment.
Operations: 2Evidence
Verification materials: metadata, masked preview, download.
Operations: 3Reports
Signed reports, their envelope and files.
Operations: 3Report verification
Public signing keys and verification of a report by reference without an API key.
Operations: 2
Review and approvals
Manual review
The review queue, document expertise and employee decisions.
Operations: 10Appeals
Applicant appeals and their resolution.
Operations: 4Approvals
Approval of changes by a second employee.
Operations: 3Alerts
Monitoring alerts and their review.
Operations: 2Risk exceptions
Limited exceptions from rules with an owner and an expiry.
Operations: 4
Coverage and placement
See it on your own scenarios
Tell us who you need to verify and where. We will prepare a demo, test API access and a price estimate.