Assignments

Decide signer identity review

Changed on

Approves or rejects a signer whose identity verification is InReview, while the document is pending_signature or pending_identity_review. Approved: once every signer has signed and no other signer is under review, the document is certificated; the certificate states the approval by review and every difference found. Rejected: the document is cancelled (rejected_by_user, with the reviewer as the user) and every signer and copy receiver gets the cancellation notice; the note is never shown to them. The signer gets no message about the decision itself. The decision is also reported to the verification provider. Not available to OAuth applications (403): the certificate names the person who reviewed, so the decision is made in Assinafy.

Copy as Markdown Open in ChatGPT Open in Claude

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

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/documents/{documentId}/assignments/{assignmentId}/signers/{signerId}/identity-verification/review
  • 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.

Request body

decision'Approved' | 'Rejected' required
notestring nullable

Optional. Recorded in the activity log and sent to the provider; never shown to the signer.

Example request

{
  "decision": "Approved",
  "note": "Conferido por videochamada."
}

Response

Decided

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