Start identity document verification
Changed onRecords the signer's biometric-processing consent and opens a provider session. Returns the hosted verification URL to redirect to. Uses the signer access code.
One live session per signer: this succeeds when no session exists yet, or when the last one Expired (the capture link lapsed before anything was submitted); the expired session is replaced by a new one. Otherwise -- Pending, In Review, Approved, Declined or Abandoned -- it returns 400. A resend never destroys or replaces a live provider session, and the account is billed once per signer at assignment creation, never again on a restart. Recovering from a Declined or Abandoned verification means the account must start a whole new process (new document, new assignment).
Request
- Base URLhttps://api.assinafy.com.br
- URLhttps://api.assinafy.com.br/v1/signers/identity-verification
- AuthAPI key in query parameter signer-access-code
Request body
Example request
{
"consent": true
}Response
Session created
Example response
{
"status": 200,
"data": {
"id": "6152120297080d55bdd13197",
"url": "https://verify.assinafy.com.br/c/01a0ed77-2afe-7f4b-bca9-349edcf4bb99#t=token",
"expires_at": "2026-10-07T21:18:47Z"
}
}Changes
- info
endpoint added
- info