Consultar Detalhes de Assinatura

---

Introdução

Este recurso retorna os detalhes de assinatura de um lote de documentos (document_batch) do investidor. Use-o depois de Buscar Lotes de Documentos para Assinatura para obter, a partir do document_batch_key, o link e o estado da assinatura.

Disponível em

Perfil	Host
Distribuidor	distributor-api

URL base de cada host: Ambientes (Hosts).

Request

ENDPOINT

/investor_registry/investor/{investor_key}/document_batch/{document_batch_key}/signature_details

MÉTODO

GET

STATUS

200

Não há corpo de requisição nem query params.

Response

O formato depende do método de assinatura do lote (signature_details.signature_method).

Response Body — certifiqi

{
    "signature_url": "https://.../events/UUID",
    "signature_details": {
        "signature_method": "certifiqi",
        "batch_group_key": "UUID"
    }
}

Response Body — qi_sign

{
    "signature_details": {
        "signature_method": "qi_sign"
    }
}

Campo	Tipo	Descrição
signature_url	string	Link para a assinatura. Presente apenas quando signature_method é certifiqi
signature_details	object	Detalhes do lote no serviço de assinatura
signature_details.signature_method	string	certifiqi ou qi_sign
signature_details.batch_group_key	string	Chave do grupo de assinatura. Presente quando signature_method é certifiqi

Demais campos de signature_details

O objeto signature_details é repassado como o serviço de assinatura o devolve. Além dos campos da tabela, ele pode trazer outros dados do lote; não dependa de campos que não estejam listados aqui.

Erros

Status	Código	Quando acontece
403	IVR000119	O lote não pertence a este investidor
404	IVR000008	Investidor não encontrado
404	IVR000032	Lote de documentos não encontrado
404	IVR000118	Não há documentos a assinar neste lote

Erros de autenticação, permissão e host: veja Erros da API.