How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Celcoin

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.2.0, at version 1.0.0.0.

Requests are made against the base URL https://api.openfinance.celcoin.com.br/.

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.2.0
API Version
1.0.0.0
Base URL
https://api.openfinance.celcoin.com.br/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Celcoin Guarantee API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: 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
getGuaranteeGetLinks 5 params → 200404400500
GET
/guarantee/get-data
Retrieves comprehensive data associated with a specific document
getGuaranteeGetData 7 params → 200202404400500
POST
/guarantee
Initiates or schedules an annotation registration process
postGuarantee 2 params body → 202200404400500
POST
/guarantee/anticipation
Realiza a antecipação de pagamento de parcelas específicas
postGuaranteeAnticipation 1 param body → 200404400500
PATCH
/guarantee/{annotationId}
Alter data from annotation (Amortization)
patchGuaranteeByAnnotationId 3 params body → 202404400500
DELETE
/guarantee/{annotationId}
Delete an annotation
deleteGuaranteeByAnnotationId 3 params → 202200404400500
POST
/guarantee/contract
Send annotation contract data
postGuaranteeContract 1 param body → 200404400500
GET
/guarantee/{actionType}/{annotationId}
Get guarantee by action type by annotation id
getGuaranteeByActionTypeByAnnotationId 2 params → 200
POST
/guarantee/authorization-data
Authorize consult data
postGuaranteeAuthorizationData 1 param body → 200404400500
GET
/guarantee/annotation
Consult annotation status
getGuaranteeAnnotation 2 params → 200404400500
DELETE
/guarantee/{annotationId}/revert-refinancing
Revert refinancing of an annotation
deleteGuaranteeByAnnotationIdRevertRefinancing 4 params → 202200404400500
PUT
/guarantee/{annotationId}/reactivate
Reactivate an annotation
putGuaranteeByAnnotationIdReactivate 3 params → 202200404400500
PUT
/guarantee/{annotationId}/suspend
Suspend annotation
putGuaranteeByAnnotationIdSuspend 2 params → 202200404400500
POST
/guarantee/anticipation/cancel
Cancela a liquidação antecipada de parcelas na Dataprev (CT), revertendo o…
postGuaranteeAnticipationCancel 1 param body → 200404400503500
PUT
/guarantee/{annotationId}/cancel-processing
Cancel an annotation process
putGuaranteeByAnnotationIdCancelProcessing 2 params → 202404400500
POST
/guarantee/change-ownership
change the ownership of the annotation
postGuaranteeChangeOwnership 1 param body → 200404400500
GET
/guarantee/list-annotations
Consult a list of annotations from a relative agency
getGuaranteeListAnnotations 15 params → 200204404400500
PATCH
/guarantee/{annotationId}/change-portability-identifier
Alter portability identifier from annotation
patchGuaranteeByAnnotationIdChangePortabilityIdentifier 2 params body → 200404400500
PATCH
/guarantee/{annotationId}/change-portability-owner
Alter portability owner from annotation
patchGuaranteeByAnnotationIdChangePortabilityOwner 2 params body → 202404400500
PUT
/guarantee/guarantee-portability
Exclude contracts by portability
putGuaranteeGuaranteePortability 1 param body → 202404400500
GET
/guarantee/list-balance-check
Consult a list of balance checks
getGuaranteeListBalanceCheck 8 params → 200204404400500
GET
/guarantee/list-payment-notes
Consult list of payment note
getGuaranteeListPaymentNotes 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), AnnotationScheduleDayRequest (13 properties). Each schema is shown below with its type and property counts.

GuaranteeResponse
object
4 properties 2 required
PortabilityAlterOwnerResponse
object
8 properties 1 required
CancelAnticipationResponse
object
2 properties 2 required
ActionType
string
ReasonReversal
string
ExternalApplicant
object
2 properties
EmployeeLink
object
6 properties
CancelAnticipationRequest
object
2 properties
TypeProduct
string
Guarantee
object
31 properties
DetailsItem
object
2 properties 2 required
GetLinksEmployeeResponse
object
3 properties
StatusOperation
string
AnnotationScheduleConfigResponse
object
4 properties
AnticipationInstallmentsResponse
object
2 properties
ConsentResponse
object
2 properties 1 required
Applicant
object
3 properties
BalancesChecksResponse
object
7 properties
GetLinksEmployerResponse
object
4 properties
ReactivateAnnotationResponse
object
3 properties 2 required
Period
object
2 properties
Authorization
object
2 properties
ErrorAnnotation
object
2 properties
Errs
object
2 properties
DeleteRefinancingResponse
object
3 properties 1 required
PortabilityAlterOwnerRequest
object
2 properties
ListBalanceCheckResponse
object
7 properties
ExcludeByPortabilityResponse
object
3 properties
Config
object
2 properties
AuthorizationDataResponse
object
2 properties
AnticipationInstallmentsRequest
object
2 properties
Rubric
object
2 properties
GuaranteeRequest
object
29 properties 1 required
ConsultAnnotationResponse
object
13 properties
DeleteGuaranteeResponse
object
3 properties 2 required
ContractDataResponse
object
3 properties
Product
object
5 properties
CancelProcessAnnotationResponse
object
2 properties 2 required
ConsultPaymentNoteListResponse
object
8 properties
ContractInfo
object
3 properties
ReasonEndContract
string
GuaranteeAlterRequest
object
12 properties
GetLinksLinkResponse
object
3 properties
AnnotationScheduleDayRequest
object
13 properties
AccountInfo
object
6 properties
ExcludedContractRequest
object
2 properties
GetLinksResponse
object
1 property
AnnotationSuspendResponse
object
3 properties 2 required
CheckBalanceContractResponse
object
1 property
AccountRequest
object
6 properties
ErrorResponse
object
3 properties
ExcludeByPortabilityRequest
object
5 properties 3 required
OwnershipChangeDetail
object
2 properties 2 required
AuthorizationDataRequest
object
6 properties 6 required
GuaranteeAlterResponse
object
3 properties 2 required
PortabilityAlterUniqueNumberResponse
object
6 properties
ChangeOwnershipResponse
object
1 property 1 required
AuthorizationDetail
object
3 properties
PaymentNoteItemResponse
object
10 properties
ChangeOwnershipRequest
object
3 properties 3 required
OperationAnnotationResponse
object
7 properties
StatusContract
string
ConsultAnnotationType
string
ContractDataRequest
object
20 properties 1 required
GuaranteeAnnotationScheduleConfigRequest
object
4 properties
OperationAnnotation
object
9 properties
PortabilityChangeUniqueNumberRequest
object
2 properties
AuthorizationPortability
object
5 properties
Employer
object
4 properties
PaymentNoteType
string
ConsultAnnotationListResponse
object
7 properties
LimitRangeType
string
AnnotationResponse
object
13 properties
ChangeOwnershipResponseStatus
object
3 properties 3 required
Employee
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celcoin-guarantee-api-openapi.yml Raw ↑

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 Proposal API
AE Profile APIs.io
Celcoin Settlement API
AE Profile APIs.io
#Guarantee
← Back to C APIs
API Details
ID
celcoin:celcoin-guarantee-api
Base URL
https://api.openfinance.celcoin.com.br/
Docs
https://developers.celcoin.com.br/docs/sobre-o-baas
Provider
Celcoin
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=celcoin-guarantee-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/celcoin-guarantee-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Celcoin Guarantee API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.