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 NaturalPerson API

The NaturalPerson API from Celcoin — 2 operation(s) for naturalperson.

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

Tagged areas include NaturalPerson. 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 11 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 11 schemas 1 POST1 PUT

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 NaturalPerson 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 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

NaturalPerson 2
POST
/onboarding-proposal/natural-person
Cria uma nova proposta de criação de conta Pessoa Física.
body → 200400401404500422
PUT
/onboarding-proposal/account/{account}/natural-person
Criação de proposta para atualização de dados cadastrais de uma Pessoa Física.
1 param body → 200400401404422500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are NaturalPersonRequest (13 properties), FinancialDetails (9 properties), NaturalPersonUpdateRequest (7 properties), AddressRequest (7 properties). Each schema is shown below with its type and property counts.

AddressRequest
object
Endereço.
7 properties 6 required
FileRequest
object
Representante/Sócio
2 properties 2 required
NaturalPersonUpdateRequest
object
7 properties 6 required
NaturalPersonUpdateResponse
object
4 properties
NaturalPersonUpdateResponseProcessingResponse
object
3 properties
NaturalPersonResponseProcessingResponse
object
3 properties
FinancialDetails
object
9 properties
NaturalPersonRequest
object
13 properties 9 required
ErrorResponse
object
3 properties
ResponseError
object
2 properties 2 required
NaturalPersonResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celcoin-naturalperson-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 OutstandingBalance API
Celcoin Proposal API