Celcoin Guarantee API

The Guarantee API from Celcoin — 21 operation(s) for guarantee.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 22 operations across 21 paths, and defines 75 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.

22 operations 21 paths 75 schemas 2 DELETE7 GET3 PATCH6 POST4 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

Authentication & Security 1

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

Bearer — Autenticação utilizando JTW Bearer Token

Paths & Operations 22

Across 21 paths, the API surfaces 22 operations — 2 DELETE, 7 GET, 3 PATCH, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Guarantee 22

GET

/guarantee/get-links

Consults the employment links associated with a specific document.

5 params → 200404400500

GET

/guarantee/get-data

Retrieves comprehensive data associated with a specific document.

7 params → 200202404400500

POST

/guarantee

Initiates or schedules an annotation registration process.

2 params body → 202200404400500

POST

/guarantee/anticipation

Realiza a antecipação de pagamento de parcelas específicas.

1 param body → 200404400500

PATCH

/guarantee/{annotationId}

Alter data from annotation (Amortization)

3 params body → 202404400500

DELETE

/guarantee/{annotationId}

Delete an annotation

3 params → 202200404400500

POST

/guarantee/contract

Send annotation contract data

1 param body → 200404400500

GET

/guarantee/{actionType}/{annotationId}

2 params → 200

POST

/guarantee/authorization-data

Authorize consult data

1 param body → 200404400500

GET

/guarantee/annotation

Consult annotation status

2 params → 200404400500

DELETE

/guarantee/{annotationId}/revert-refinancing

Revert refinancing of an annotation.

4 params → 202200404400500

PUT

/guarantee/{annotationId}/reactivate

Reactivate an annotation

3 params → 202200404400500

PUT

/guarantee/{annotationId}/suspend

Suspend annotation.

2 params → 202200404400500

POST

/guarantee/anticipation/cancel

Cancela a liquidação antecipada de parcelas na Dataprev (CT), revertendo o contrato à programação normal de descontos na competência informada.

1 param body → 200404400503500

PUT

/guarantee/{annotationId}/cancel-processing

Cancel an annotation process

2 params → 202404400500

POST

/guarantee/change-ownership

change the ownership of the annotation

1 param body → 200404400500

GET

/guarantee/list-annotations

Consult a list of annotations from a relative agency

15 params → 200204404400500

PATCH

/guarantee/{annotationId}/change-portability-identifier

Alter portability identifier from annotation

2 params body → 200404400500

PATCH

/guarantee/{annotationId}/change-portability-owner

Alter portability owner from annotation

2 params body → 202404400500

PUT

/guarantee/guarantee-portability

Exclude contracts by portability

1 param body → 202404400500

GET

/guarantee/list-balance-check

Consult a list of balance checks

8 params → 200204404400500

GET

/guarantee/list-payment-notes

Consult list of payment note.

9 params → 200204404400500

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are Guarantee (31 properties), GuaranteeRequest (29 properties), ContractDataRequest (20 properties), ConsultAnnotationResponse (13 properties). Each schema is shown below with its type and property counts.

ChangeOwnershipResponse

object

1 property 1 required

GetLinksEmployerResponse

object

4 properties

ChangeOwnershipRequest

object

3 properties 3 required

AuthorizationPortability

object

5 properties

ReasonReversal

string

ConsultAnnotationListResponse

object

7 properties

ChangeOwnershipResponseStatus

object

3 properties 3 required

Rubric

object

2 properties

Employee

object

3 properties

GuaranteeAlterResponse

object

3 properties 2 required

PortabilityAlterOwnerResponse

object

8 properties 1 required

ErrorAnnotation

object

2 properties

ListBalanceCheckResponse

object

7 properties

DeleteRefinancingResponse

object

3 properties 1 required

Errs

object

2 properties

GetLinksResponse

object

1 property

AccountInfo

object

6 properties

AnnotationSuspendResponse

object

3 properties 2 required

AuthorizationDataRequest

object

6 properties 6 required

GuaranteeRequest

object

29 properties 1 required

EmployeeLink

object

6 properties

TypeProduct

string

GetLinksEmployeeResponse

object

3 properties

ExcludedContractRequest

object

2 properties

DetailsItem

object

2 properties 2 required

PaymentNoteType

string

OwnershipChangeDetail

object

2 properties 2 required

Applicant

object

3 properties

Period

object

2 properties

AuthorizationDetail

object

3 properties

Guarantee

object

31 properties

PortabilityAlterOwnerRequest

object

2 properties

ConsultAnnotationType

string

ConsentResponse

object

2 properties 1 required

StatusOperation

string

OperationAnnotationResponse

object

7 properties

ContractDataResponse

object

3 properties

ReasonEndContract

string

GuaranteeAlterRequest

object

12 properties

ReactivateAnnotationResponse

object

3 properties 2 required

GuaranteeResponse

object

4 properties 2 required

AccountRequest

object

6 properties

Product

object

5 properties

PortabilityAlterUniqueNumberResponse

object

6 properties

CheckBalanceContractResponse

object

1 property

BalancesChecksResponse

object

7 properties

AnnotationResponse

object

13 properties

OperationAnnotation

object

9 properties

PortabilityChangeUniqueNumberRequest

object

2 properties

CancelAnticipationRequest

object

2 properties

AuthorizationDataResponse

object

2 properties

AnticipationInstallmentsRequest

object

2 properties

ContractInfo

object

3 properties

Employer

object

4 properties

ConsultPaymentNoteListResponse

object

8 properties

ExcludeByPortabilityRequest

object

5 properties 3 required

LimitRangeType

string

ErrorResponse

object

3 properties

AnnotationScheduleDayRequest

object

13 properties

GetLinksLinkResponse

object

3 properties

ConsultAnnotationResponse

object

13 properties

ContractDataRequest

object

20 properties 1 required

AnnotationScheduleConfigResponse

object

4 properties

StatusContract

string

CancelProcessAnnotationResponse

object

2 properties 2 required

Config

object

2 properties

Authorization

object

2 properties

CancelAnticipationResponse

object

2 properties 2 required

PaymentNoteItemResponse

object

10 properties

GuaranteeAnnotationScheduleConfigRequest

object

4 properties

ExternalApplicant

object

2 properties

ExcludeByPortabilityResponse

object

3 properties

DeleteGuaranteeResponse

object

3 properties 2 required

AnticipationInstallmentsResponse

object

2 properties

ActionType

string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Celcoin publishes across the network.

Celcoin Card Solutions API

AE Profile APIs.io

Celcoin Payments API

AE Profile APIs.io

Celcoin Open Finance API

AE Profile APIs.io

Celcoin AnnotationCompetenceCalendar API

AE Profile APIs.io

Celcoin BankCorrespondentAgent API

AE Profile APIs.io

Celcoin Consignee API

AE Profile APIs.io

Celcoin Files API

AE Profile APIs.io

Celcoin LegacyGuarantee API

AE Profile APIs.io

Celcoin LegalPerson API

AE Profile APIs.io

Celcoin NaturalPerson API

AE Profile APIs.io

Celcoin OutstandingBalance API

AE Profile APIs.io

Celcoin Proposal API

AE Profile APIs.io

#Guarantee

← Back to C APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Celcoin Guarantee API

Metadata

Authentication & Security 1

Paths & Operations 22

Schemas 75

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Celcoin Guarantee API

Metadata

Authentication & Security 1

Paths & Operations 22

Schemas 75

Specification

Source

More from Celcoin 12

API Details

Provider

Explore more