improved

Document and identity verifications redesign

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:

BeforeAfter
POST /id_document_verificationsPOST /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:

BeforeAfter
legal_entity_namelegal_person
first name and last namenatural_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:

BeforeAfter
approvedverified
declinedfailed
  • New status codes

New prefixed status codes help identify the type of verification:

VerificationBeforeAfter
Video identity verification1201IDVV_1201
Document identity verification1103IDDV_1103
Bank account verification1602BAV_1602

Webhook

Event names have been updated for clarity and alignment:

VerificationBeforeAfter
Video identity verificationvideo_identity_verification.doneverification.identity_video.done
Document identity verificationid_document_verification.doneverification.identity_document.done
Bank account verificationbank_account_verification.doneverification.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: