Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Celcoin Proposal API

The Proposal API from Celcoin — 2 operation(s) for proposal.

Celcoin Proposal API is one of 15 APIs that Celcoin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Proposal. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.0.1, at version v1.0.0.

Requests are made against a single base URL, https://sandbox.openfinance.celcoin.dev/billissuance/v1.

2 operations 2 paths 13 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1.0.0
Base URL
https://api.openfinance.celcoin.com.br/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Celcoin Proposal API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer).

  • Bearer — Autenticação utilizando JTW Bearer Token

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Proposal 2
POST
/proposal/linked-request
Include a linked proposal
1 param body → 200202404400500
GET
/onboarding-proposal
Busca uma proposta ou uma lista de propostas.
9 params → 200400401404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ProposalLinkedRequest (13 properties), ProposalResponse (9 properties), DocumentscopyResponse (7 properties), SearchProposalResponse (6 properties). Each schema is shown below with its type and property counts.

SearchProposalResponseSuccessResponse
object
3 properties
Contact
object
2 properties 1 required
ErrorResponse_2
object
3 properties
ProposalLinkedRequest
object
13 properties
ProposalLinkedResponse
object
4 properties
ProposalContact
string
SearchProposalResponse
object
6 properties
RejectedReasonResponse
object
Motivo pelo qual a proposta foi rejeitada.
2 properties
DocumentscopyResponse
object
Documentoscopia(s) retornada(s).
7 properties
ErrorResponse
object
3 properties
ProposalResponse
object
Proposta(s) retornada(s).
9 properties
Errs
object
2 properties
ResponseError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celcoin-proposal-api-openapi.yml Raw ↑

Other APIs Celcoin publishes across the network.

Celcoin Card Solutions API
Celcoin Payments API
Celcoin Open Finance API
Celcoin AnnotationCompetenceCalendar API
Celcoin BankCorrespondentAgent API
Celcoin Consignee API
Celcoin Files API
Celcoin Guarantee API
Celcoin LegacyGuarantee API
Celcoin LegalPerson API
Celcoin NaturalPerson API
Celcoin OutstandingBalance API