These docs are for v1.0. Click to read the latest docs for v3.0.

Visualizar todos os signatários

GET /api/v2/signers?page=number&

📘

Requisição para visualizar lista de signatários vinculados à conta do cliente. Esta é uma requisição GET para /api/v2/signers?page=number&, sendo number o número da página. Os atributos do contato aparecerão no body.

Signers: atributos de visualização

Atributo

Descrição

Exemplo

key

Chave do signatário.

4c833e5c-86ed-414d-9b83-2f12d1af4438

name

Nome do signatário.

João Silva

email

E-mail do signatário.

[email protected]

documentation

Documento do signatário.

123.321.123-40

Page_infos: atributos de listagem das páginas

📘

São listados até 30 signatários por página

Atributo

Descrição

Exemplo

total_pages

Quantidade total de páginas.

3

current_page

Número da página que está sendo visualizada.

1

next_page

Número da próxima página que será visualizada.

2

prev_page

Número da página anterior.

null

first_page?

Determina se é a primeira página da listagem.

true

last_page?

Determina se é a última página da listagem.

false

❗️

Se a requisição para a Clicksign falhar

Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

GET /api/v2/signers?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "signers": [
        {
            "key": "4c833e5c-86ed-414d-9b83-2f12d1af4438",
            "email": "[email protected]",
            "auths": [
                "sms"
            ],
            "delivery": "email",
            "name": "João Silva",
            "documentation": null,
            "selfie_enabled": false,
            "handwritten_enabled": false,
            "birthday": null,
            "phone_number": "3481881888",
            "has_documentation": false,
            "created_at": "2022-11-30T09:21:28.336-03:00",
            "updated_at": "2022-11-30T09:21:28.336-03:00",
            "official_document_enabled": false,
            "liveness_enabled": false,
            "facial_biometrics_enabled": false
        },
        {
            "key": "b3798fe3-07c6-4ccd-b214-a3570c5fd753",
            "email": "[email protected]",
            "auths": [
                "sms"
            ],
            "delivery": "email",
            "name": "Maria Santos",
            "documentation": null,
            "selfie_enabled": false,
            "handwritten_enabled": false,
            "birthday": null,
            "phone_number": "34991119555",
            "has_documentation": false,
            "created_at": "2022-11-30T09:20:53.231-03:00",
            "updated_at": "2022-11-30T09:20:53.231-03:00",
            "official_document_enabled": false,
            "liveness_enabled": false,
            "facial_biometrics_enabled": false
        }
    ],
    "page_infos": {
        "total_pages": 2,
        "current_page": 1,
        "next_page": 2,
        "prev_page": null,
        "first_page?": true,
        "last_page?": false
    }
}