---
title: "Busca uma proposta ou uma lista de propostas."
method: GET
path: "/onboarding-proposal"
tags: ["Proposal"]
---

# Busca uma proposta ou uma lista de propostas.

`GET /onboarding-proposal`

## Request

- Base URL: `https://sandbox.openfinance.celcoin.dev/onboarding/v1`
- URL: `https://sandbox.openfinance.celcoin.dev/onboarding/v1/onboarding-proposal`
- Auth: API key in header `Authorization`

## Query parameters

- `ProposalId` string, nullable: Id da proposta a ser buscada.
- `ClientCode` string, nullable: Identificador único do cliente a ser buscado.
- `DateFrom` string, date-time, nullable: Data inicial.
- `DateTo` string, date-time, nullable: Data final.
- `Status` string, nullable: Status da proposta: - CREATED - PENDING - PENDING_DOCUMENTSCOPY - APPROVED - REPROVED - RESOURCE_ERROR - RESOURCE_CREATED - PROCESSING_DOCUMENTSCOPY
- `DocumentNumber` string, nullable: Documento da proposta.
- `Page` integer: Pagina de solicitaçao, default: 1.
- `Limit` integer: Limite geral da consulta.
- `LimitPerPage` integer: Total de propostas por pagina.

## Response `200`

OK

- SearchProposalResponseSuccessResponse
  - `version` string, nullable: Versão da api.
  - `status` string, nullable: Status da solicitação.
  - `body` SearchProposalResponse
    - `limit` integer: Total de propostas.
    - `currentPage` integer: Página atual.
    - `limitPerPage` integer: Total de propostas por página.
    - `totalPages` integer: Total de páginas retornadas.
    - `totalItems` integer: Total de propostas retornadas.
    - `proposal` ProposalResponse[], nullable
      - `proposalId` string, nullable: Identificador da proposta.
      - `clientCode` string, nullable: Identificador único fornecido pelo cliente.
      - `documentNumber` string, nullable: CPF ou CNPJ da proposta.
      - `status` string, nullable: Status da proposta: - CREATED - PENDING - PENDING_DOCUMENTSCOPY - APPROVED - REPPROVED - RESOURCE_CREATED - RESOURCE_ERROR - PROCESSING_DOCUMENTSCOPY
      - `proposalType` string, nullable: Tipo da proposta: - PF - PJ
      - `documentscopys` DocumentscopyResponse[], nullable
        - `createdAt` string, date-time: Data de criação da documentoscopia.

## Other responses

- `400`: Error handled by the application
- `401`: Access Denied
- `404`: Not Found
- `500`: Unknown error

---

[API](https://skmtc.dev/celcoin/apis/onboarding-proposal-webservice.md) - [All operations](https://skmtc.dev/celcoin/apis/onboarding-proposal-webservice/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/onboarding-proposal-webservice/revisions/066414038a50?raw)