API reference
Every secuveri API endpoint and webhook event, with parameters, request bodies, responses and code samples, generated from the OpenAPI 3.1 spec.
Requests go to https://api-verify.secuveri.com with your API key in the x-api-key header, and answer JSON. Download the OpenAPI 3.1 spec (also as YAML).
Sessions
Results and keys
AML screening
Business verification (KYB)
- POST
/v1/kyb/casesOpen a business verification (KYB) case - GET
/v1/kyb/cases/{id}Read a business case - GET
/v1/kyb/searchSearch the commercial register by name - POST
/v1/kyb/cases/{id}/persons/{personId}/verificationStart a person's verification - POST
/v1/kyb/cases/{id}/declarationDeclare the beneficial owners - POST
/v1/kyb/cases/{id}/documentsUpload a commercial register extract
Standalone checks
- POST
/v1/face/matchCompare a selfie with a reference portrait - POST
/v1/liveness/checkPassive liveness on one to three selfies - POST
/v1/age/estimateEstimate a person's age from their face - POST
/v1/content-credentials/checkRead an image's Content Credentials (C2PA) - POST
/v1/documents/verifyVerify an identity document - GET
/v1/documents/verify/{id}Read a verify an identity document check - POST
/v1/proof-of-address/readRead a proof of address - GET
/v1/proof-of-address/read/{id}Read a read a proof of address check
Block and allow lists
Webhook events
verification.completedA verification reached a final status without needing a person.verification.review_requiredA verification is waiting for a reviewer.verification.reviewedA reviewer approved or rejected a verification.verification.expiredA session expired before the person finished.kyb_case.completedA business case was approved or declined without a reviewer.kyb_case.review_requiredA business case is waiting for a reviewer.kyb_case.reviewedA reviewer approved or declined a business case.documents.verify.completedA standalone document check ended. data.check_id is the id for GET /v1/documents/verify/{id}; data.status is COMPLETED or FAILED.proof_of_address.read.completedA standalone proof-of-address read ended. data.check_id is the id for GET /v1/proof-of-address/read/{id}.