To simplify the experience across all our verification products, we’ve redesigned several aspects of the solution for:
- Video identity verification
- Document identity verification
- Bank account verification
This redesign includes renamed endpoints and parameters, richer response payloads, new statuses and status codes, and updated Webhook events.
What is changing?
Endpoint route naming
We've updated the naming of several endpoints to group them under a more consistent namespace:
Before | After |
---|---|
POST /id_document_verifications | POST /verifications/identity_documents |
GET /bank_account_verifications/{id} | GET /verifications/bank_accounts/{id} |
Endpoint parameter names
Some parameter names have been harmonized across verification types:
Before | After |
---|---|
legal_entity_name | legal_person |
first name and last name | natural_person |
Response format changes
We’ve enriched all the POST and GET endpoints by providing more information in the responses.
For example, before, only the id
was returned when initiating a verification.
Now you’ll also receive:
workspace_id
created_at
,updated_at
status
status_codes
data_anonymized
data
This gives you better visibility into the lifecycle of a verification.
New status & status codes
- New status
We’re aligning the former approved
and declined
statuses across all verification types:
Before | After |
---|---|
approved | verified |
declined | failed |
- New status codes
New prefixed status codes help identify the type of verification:
Verification | Before | After |
---|---|---|
Video identity verification | 1201 | IDVV_1201 |
Document identity verification | 1103 | IDDV_1103 |
Bank account verification | 1602 | BAV_1602 |
Webhook
Event names have been updated for clarity and alignment:
Verification | Before | After |
---|---|---|
Video identity verification | video_identity_verification.done | verification.identity_video.done |
Document identity verification | id_document_verification.done | verification.identity_document.done |
Bank account verification | bank_account_verification.done | verification.bank_account.done |
The Webhook payloads have also been improved for better traceability.
📘 For full details on all changes, including routes, parameters, payload examples, check out our updated guides: