consultar_solicitacoes

Request

Pensando em facilitar o processo, caso o cliente queira fazer uma nova consulta com novas datas base à alguem que já fora previamente consultado, oferecemos a operação /scr/redo. A vantagem de utilizar esta operação é que, caso o documento de autorização para aquela pessoa ainda esteja válido, não haverá a criação de um novo documento para assinatura¹ e a consulta será criada imediatamente. O formato de assinatura do header e do body desta requisição é descrito em detalhes aqui.

• ENDPOINT
  /scr
• MÉTODO
  GET

QUERY PARAMS

Campo	Tipo	Descrição
origin_key	string	Chave de identificação da operação. Retorna todas as consultas referentes à aquela operação.
subject_person_type	enum	Filtro de tipo de pessoa consultada.
subject_document_number	string	Filtro de "CPF" ou "CNPJ", não aceita parcial.
created_at_start_date	string	Filtro de inicio da faixa de data de criação (formato: YYYY-MM-DD).
created_at_end_date	string	Filtro de fim da faixa de data de criação (formato: YYYY-MM-DD).
consulted_at_start_date	string	Filtro de inicio da faixa de data de consulta (formato: YYYY-MM-DD).
consulted_at_end_date	datetime	Filtro de fim da faixa de data de consulta (formato: YYYY-MM-DD).
scr_status	enum	Filtro de status da consulta.
page	integer	Página atual que está sendo consultada.
page_size	integer	Quantidade de resultados que cabem na página.

Enumeradores

Enumeradores person_type

Enumerador	Tradução
natural	Pessoa fisica
legal	Pessoa juridica

Enumeradores scr_status

Enumerador	Tradução
created	Criado
pending_signature	Assinatura pendente
signed	Assinado
rejected	Rejeitado
consulted	Consultado
error	Com erro
canceled	Cancelado

Response

status:

200

Response Body

{
    "data": [
        {
            "consent_term": null,
            "consulted_at": null,
            "created_at": "2020-04-24",
            "report_end_date": "2020-03",
            "report_start_date": "2020-01",
            "result_document": null,
            "origin_key": "db5d1627-841f-4ddd-97f8-925557531718",
            "scr_status": "pending_signature",
            "signers": [
                {
                    "name": "Diretor 1",
                    "document_number": "03030230074",
                    "email": "diretor1@email.com"
                },
                {
                    "name": "Diretor 2",
                    "document_number": "03030230074",
                    "email": "diretor2@email.com"
                }
            ],
            "subject_document_number": "05305188000108",
            "subject_name": "Padaria do Joao Ninguem",
            "subject_person_type": "legal"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 100,
        "total_pages": 1,
        "total_rows": 55
    }
}

status:

400

body.json

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}