Signing
Search signer's documents
Changed onSearch the documents a signer is party to (compact representation). Accepts either the signer access code or the account's own credentials (API key or bearer token) — with account credentials, the signer must belong to that account's workspace. With the signer access code, signerId must be the code's own signer (otherwise 403), only documents whose signing step has been reached are listed, and each assignment leaves out signing_urls.
get/v1/signers/{signerId}/documents/search
Request
- Base URLhttps://api.assinafy.com.br
- URLhttps://api.assinafy.com.br/v1/signers/{signerId}/documents/search
- Auth
- API key in query parameter signer-access-code
- or HTTP bearer
- or API key in header X-Api-Key
Path parameters
signerIdstring required
The signer ID.
Query parameters
searchstring
Search term.
Response
Matching documents
Example response
{
"status": 200,
"data": [
{
"resource": "document",
"id": "615601fab04c0a3147bb1246",
"account_id": "d199996981dbd199996981db",
"name": "document.pdf",
"status": "metadata_ready",
"artifacts": {
"original": "https://api.assinafy.com.br/v1/documents/doc1/download/original"
},
"signing_url": "https://api.assinafy.com.br/v1/sign/doc1",
"verification_code": "a3f1c9e07b2d4e8f9a6c5b1d0e7f3a2c9b8d4e6f",
"verification_url": "https://www.assinafy.com.br/verificador/a3f1c9e07b2d4e8f9a6c5b1d0e7f3a2c9b8d4e6f",
"declined_by": {
"resource": "signer",
"id": "62d6ee35c7741ca4006b9e11",
"full_name": "John Signer",
"email": "john@email.com",
"whatsapp_phone_number": "+5548999990000",
"government_id": "39053344705"
},
"assignment": {
"resource": "assignment",
"id": "615606ef81d199996981dbce",
"document_id": "615601fab04c0a3147bb1246",
"created_at": "2026-06-03T03:54:16Z",
"sender_email": "sender@example.com",
"method": "virtual",
"signers": [
{
"resource": "signer",
"id": "62d6ee35c7741ca4006b9e11",
"full_name": "John Signer",
"email": "john@email.com",
"whatsapp_phone_number": "+5548999990000",
"government_id": "39053344705",
"verification_method": "Email",
"notification_methods": [
"Email"
],
"step": 1,
"identity_verification_status": "InReview",
"notification_history": [
{
"event": "signature_request",
"status": "sent",
"sent_at": "2026-07-07T12:00:00Z"
}
]
}
],
"items": [
{
"page": {
"id": "615601faf166d6d1d8e7dc30",
"number": 1,
"height": 2100,
"width": 1275,
"download_url": "https://api.assinafy.com.br/v1/documents/doc1/pages/1a/download"
}
}
],
"signing_urls": [
{
"url": "https://api.assinafy.com.br/v1/sign/doc1?email=joe@example.com"
}
]
},
"pages": [
{
"id": "615601faf166d6d1d8e7dc30",
"number": 1,
"height": 2100,
"width": 1275,
"download_url": "https://api.assinafy.com.br/v1/documents/doc1/pages/1a/download"
}
],
"has_contract": true,
"created_at": "2026-06-03T03:54:16Z",
"updated_at": "2026-06-03T03:54:16Z"
}
]
}Changes
- info
added the optional property
///to the response with the status
- info
- breaking
the response property
////////became nullable for the status
- breaking