v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Proposal

Busca uma proposta ou uma lista de propostas.

get/onboarding-proposal

Query parameters

ProposalIdstring nullable

Id da proposta a ser buscada.

Example:3257b215-bef9-402b-a779-104441b520b4

Id da proposta a ser buscada.

ClientCodestring nullable

Identificador único do cliente a ser buscado.

Example:7817b215-beg3-801a-a779-117771t550h2

Identificador único do cliente a ser buscado.

DateFromstring date-time nullable

Data inicial.

Example:2023-11-03T09:30:00.0000000+00:00

Data inicial.

DateTostring date-time nullable

Data final.

Example:2023-11-03T09:30:00.0000000+00:00

Data final.

Statusstring nullable

Status da proposta:

CREATED
PENDING
PENDING_DOCUMENTSCOPY
APPROVED
REPROVED
RESOURCE_ERROR
RESOURCE_CREATED
PROCESSING_DOCUMENTSCOPY

Example:PENDING

Status da proposta:

CREATED
PENDING
PENDING_DOCUMENTSCOPY
APPROVED
REPROVED
RESOURCE_ERROR
RESOURCE_CREATED
PROCESSING_DOCUMENTSCOPY

DocumentNumberstring nullable

Documento da proposta.

Example:12345678909

Documento da proposta.

Pageinteger

Pagina de solicitaçao, default: 1.

Limitinteger

Limite geral da consulta.

LimitPerPageinteger

Total de propostas por pagina.

Response

versionstring nullable

Versão da api.

statusstring nullable

Status da solicitação.

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "proposal": [
      {
        "proposalId": "12334dfb-4c4e-43fb-ad93-fa28e3123473",
        "clientCode": "1234ab7c-2855-436b-9d19-8abcdc198e984",
        "proposalType": "PF"
      }
    ]
  }
}