Signers

Update a signer's information. Only the fields sent change; send just the ones you are changing.

Clearing a field: null or " clears email, whatsapp_phone_number and government_id (whatsapp_phone_number is stored as null either way; the other two keep the value sent). full_name cannot be cleared.

Verification integrity: email / whatsapp_phone_number cannot be changed while the signer has verified that channel on an in-flight (not yet certificated) document — the response is 400 naming the offending document(s). Already-certificated documents do not block updates. Changing a channel that has unverified in-flight requests rotates their access/verification codes (invalidating previously sent links/OTPs); use the resend endpoint to redeliver. full_name can always be updated.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/accounts/{accountId}/signers/{signerId}

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/accounts/{accountId}/signers/{signerId}
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

accountIdstring required

Workspace account ID.

signerIdstring required

The signer ID.

Request body

full_namestring
emailstring email

Can't be changed or cleared while the signer has verified it on an in-flight document (400).

whatsapp_phone_numberstring

E.164; normalized on save, and compared after normalizing, so the same number in another format is not a change. Can't be changed or cleared while the signer has verified it on an in-flight document (400).

government_idstring

Signer's CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). Formatting is accepted and the value is normalized on save.

Example request

{
  "full_name": "John Dove",
  "email": "john@email.com",
  "whatsapp_phone_number": "+5548999990000",
  "government_id": "390.533.447-05"
}

Response

The updated signer

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "resource": "signer",
    "id": "62d6ee35c7741ca4006b9e11",
    "full_name": "John Signer",
    "email": "john@email.com",
    "whatsapp_phone_number": "+5548999990000",
    "government_id": "39053344705"
  }
}

Changes

    • info

      added the optional property // to the response with the status