Assignments

Signer identity review

Changed on

The signer's identity-document verification as the account's reviewer sees it. When the provider sends a verification to review, the account decides it with Decide signer identity review. The signer can still view and sign meanwhile; the review holds the document's certification instead (status pending_identity_review once every signer has signed). Evidence is a summary kept by Assinafy (no images or biometrics). evidence_available is false when the provider keeps none or it could not be fetched yet. While the review is open, images lists the evidence images the reviewer can open with Signer identity review image. A verification the provider approved directly, without a review, shows no evidence here (evidence_available is false); its evidence is on the signer_identity_verified activity. Reachable with the documents:read OAuth scope, but the images and the decision are not available to OAuth applications (403): the review is made by a person in Assinafy.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/documents/{documentId}/assignments/{assignmentId}/signers/{signerId}/identity-verification

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/documents/{documentId}/assignments/{assignmentId}/signers/{signerId}/identity-verification
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

documentIdstring required

Document ID.

assignmentIdstring required

The assignment ID.

signerIdstring required

The signer ID.

Response

Identity review

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "id": "104c267f8e1e8c6855d7788b76a8",
    "status": "InReview",
    "provider": "AssinafyVerify",
    "verification_method": "IdDocumentFaceMatchBasic",
    "reason_codes": [
      {
        "code": "NAME_MISMATCH",
        "description": "Nome no documento difere do cadastrado (similaridade 52%)"
      }
    ],
    "evidence_available": true,
    "expected": {
      "name": "Maria da Silva",
      "cpf": "52998224725"
    },
    "document": {
      "type": "CNH",
      "name": "MARIA SILVA",
      "cpf": "52998224725"
    },
    "matches": {
      "cpf": true,
      "name": 0.5217
    },
    "checks": [
      {
        "name": "name",
        "result": "review",
        "score": 0.5217,
        "reasons": [
          "NAME_MISMATCH"
        ]
      }
    ],
    "images": [
      "document_front",
      "document_back",
      "face"
    ],
    "ruleset_version": "2026-10-12.2",
    "evidence_sha256": "9f2c0d6e4b1a8c3f5e7d9b0a2c4e6f8a1b3d5f7091e2c4a6b8d0f2e4a6c8e0b2",
    "reviewed_by": {
      "id": "Kx9pQ2",
      "name": "Ana Souza"
    },
    "reviewed_at": "2026-10-13T21:05:00Z",
    "review_note": "Conferido por videochamada.",
    "completed_at": "2026-10-13T21:05:00Z"
  }
}

Changes