Credit infrastructure APIs for CCB (Cédula de Crédito Bancário) issuance, escrow account management, consigned credit (Consignado as a Service), credit portability, commercial notes (CCA), and portfolio management and collections.
{
"openapi": "3.0.1",
"info": {
"title": "API",
"version": "1.0.0.0"
},
"paths": {
"/annotation-competence-calendar": {
"get": {
"tags": [
"AnnotationCompetenceCalendar"
],
"parameters": [
{
"name": "QueryType",
"in": "query",
"schema": {
"$ref": "#/components/schemas/AnnotationCompetenceCalendarQueryType"
}
},
{
"name": "CompetencePeriod",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ConsigneeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "AgencyId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationCompetenceCalendarResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/correspAgent": {
"post": {
"tags": [
"BankCorrespondentAgent"
],
"summary": "Creates a new bank correspondent agent.",
"requestBody": {
"description": "Data required to create the bank correspondent agent.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCorrespAgentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateCorrespAgentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateCorrespAgentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCorrespAgentResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"get": {
"tags": [
"BankCorrespondentAgent"
],
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "correspAgentId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "consigneeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "document",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCorrespAgentResponse"
}
}
}
},
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/bankcorrespondentagent/{correspAgentId}": {
"put": {
"tags": [
"BankCorrespondentAgent"
],
"summary": "Update an existing bank correspondent agent",
"parameters": [
{
"name": "correspAgentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBankCorrespondentAgentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBankCorrespondentAgentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateBankCorrespondentAgentRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankCorrespondentAgentResponse"
}
}
}
},
"304": {
"description": "Not Modified"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"BankCorrespondentAgent"
],
"summary": "Inactivate an existing bank correspondent agent",
"parameters": [
{
"name": "correspAgentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BankCorrespondentAgentResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/consignee": {
"post": {
"tags": [
"Consignee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateConsigneeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateConsigneeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateConsigneeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateConsigneeResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Consignee"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConsigneeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConsigneeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateConsigneeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsigneeResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Consignee"
],
"parameters": [
{
"name": "consigneeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsigneeResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Consignee"
],
"parameters": [
{
"name": "consigneeId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agencyId",
"in": "query",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteConsigneeResponse"
}
}
}
}
}
}
},
"/guarantee/get-links": {
"get": {
"tags": [
"Guarantee"
],
"summary": "Consults the employment links associated with a specific document.",
"parameters": [
{
"name": "document",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "consigneeId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "agencyId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "token-data",
"in": "header",
"description": "Authorization Token (only if needed)",
"schema": {
"type": "string"
}
},
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLinksResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/guarantee/get-data": {
"get": {
"tags": [
"Guarantee"
],
"summary": "Retrieves comprehensive data associated with a specific document.",
"parameters": [
{
"name": "document",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "consigneeId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "agencyId",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "periods",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "registration",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "token-data",
"in": "header",
"description": "Authorization Token (only if needed)",
"schema": {
"type": "string"
}
},
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckBalanceContractResponse"
}
}
}
},
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/guarantee": {
"post": {
"tags": [
"Guarantee"
],
"summary": "Initiates or schedules an annotation registration process.",
"parameters": [
{
"name": "Pin",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Annotation request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeResponse"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/guarantee/anticipation": {
"post": {
"tags": [
"Guarantee"
],
"summary": "Realiza a antecipação de pagamento de parcelas específicas.",
"parameters": [
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Antecipação de parcelas request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnticipationInstallmentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AnticipationInstallmentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AnticipationInstallmentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnticipationInstallmentsResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/guarantee/{annotationId}": {
"patch": {
"tags": [
"Guarantee"
],
"summary": "Alter data from annotation (Amortization)",
"parameters": [
{
"name": "annotationId",
"in": "path",
"description": "Id from annotation",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Pin",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeAlterRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeAlterRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeAlterRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GuaranteeAlterResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Guarantee"
],
"summary": "Delete an annotation",
"parameters": [
{
"name": "annotationId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "reason",
"in": "query",
"description": "",
"schema": {
"$ref": "#/components/schemas/ReasonEndContract"
}
},
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteGuaranteeResponse"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteGuaranteeResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/guarantee/contract": {
"post": {
"tags": [
"Guarantee"
],
"summary": "Send annotation contract data",
"parameters": [
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ContractDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ContractDataRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContractDataResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/guarantee/{actionType}/{annotationId}": {
"get": {
"tags": [
"Guarantee"
],
"parameters": [
{
"name": "actionType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "annotationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentResponse"
}
}
}
}
}
}
},
"/guarantee/authorization-data": {
"post": {
"tags": [
"Guarantee"
],
"summary": "Authorize consult data",
"parameters": [
{
"name": "correspAgentId",
"in": "header",
"description": "Bank Correspondent Agent Id",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/
# --- truncated at 32 KB (153 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/celcoin/refs/heads/main/openapi/celcoin-credit-openapi.json