Signing

Sign assignment items

Changed on

Sign a document with input fields (collect method): submit the signer's item values, completing their items. Signing again after the signer has signed changes nothing and returns the current assignment. For virtual assignments the signer must first confirm their data via PUT /v1/documents/{documentId}/signers/confirm-data, otherwise this returns 400 (Signer data must be confirmed before signing). Signers whose verification method is DigitalCertificate cannot use this endpoint — their signature must be produced through POST /v1/signers/certificate/start + /complete, and this returns 400. The request body is a JSON array of item entries. Uses the signer access code.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/documents/{documentId}/assignments/{assignmentId}

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/documents/{documentId}/assignments/{assignmentId}
  • Auth
    API key in query parameter signer-access-code

Path parameters

documentIdstring required

Document ID.

assignmentIdstring required

The assignment ID.

Request body

itemIdstring required

The assignment item ID.

fieldIdstring required

Field associated with the item.

pageIdstring required

The page ID.

valuestring required

String representation of the value.

Example request

[
  {
    "itemId": "615606efcde1a39c9d21e30e",
    "fieldId": "6152120297080d55bdd13197",
    "pageId": "615213ed81b071f4293b2fc2",
    "value": "Signed by Sonny Bayer"
  }
]

Response

Signing result

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

dataobject

Example response

{
  "status": 200
}

Changes