Busca de Envelopes
A consulta dos envelopes existentes é feita através filtros como CPF, Status e UUID do Envelope. Existe paginação no resultado da busca. Apesar de todos os campos serem opcionais o body é obrigatório.
POST
https://signhom.acesso.io/api/v1/service/envelopes
Headers
Name
Type
Description
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Request Body
Name
Type
Description
Status
integer
0 - Expirados 1 - Pendentes 2 - Concluídos 3 - Cancelados 4 - Processando 5 - Recusados
Page
string
Número da página de resultado
CPF
string
CPF do assinante
EnvelopeUUID
string
UUID do envelope
{
"Success": true,
"Message": "",
"Data": {
"Page": 1,
"MaxPage": 363,
"Count": 10886,
"Envelopes": [
{
"CreatedDate": "21/05/2018 17:24",
"ID_EnvelopeStatus": 1,
"EnvelopeStatus": "Pendente",
"UUID": "x11x111x-x11x-1111-11x1-11x111x1xx1x",
"Documents": [
{
"Url": "https://signhom.acesso.io/api/v1/service/file/y00y000y-y00y-0000-00y0-00y000y0yy00",
"UrlVoucher": "https://sign.acesso.io/api/v1/service/evidence/y00y000y-y00y-0000-00y0-00y000y0yy00",
"DocumentType": "Teste Core",
"CreatedDate": "21/05/2018 17:24",
"CompanySocialName": "ACESSO DIGITAL",
"UUID": "y00y000y-y00y-0000-00y0-00y000y0yy00",
"Subscribers": [
{
"SubscriberName": "Nome do Assinante Primeiro",
"SubscriberCPF": "11122233344",
"SubscriberEmail": "nome@email.com",
"SubscriberPhone": "5511999988888",
"SubscriberRole": 1,
"URLFrameFull": "https://url/client/?token=JymY0s0s0s0d0sa0d0sd0sa0dsa0d"
}
]
}
]
}
]
}
}
Exemplos de Requisição
{
"EnvelopeUUID": "x11x111x-x11x-1111-11x1-11x111x1xx1x"
}
{
"CPF": "11111111111",
"Page": "1"
}
{ }
Last updated
Was this helpful?