The Consignee API from Celcoin — 1 operation(s) for consignee.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/celcoin-consignee-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: billissuance-settlement-webservice AnnotationCompetenceCalendar Consignee API
version: v1.0.0
servers:
- url: https://sandbox.openfinance.celcoin.dev/billissuance/v1
tags:
- name: Consignee
paths:
/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'
components:
schemas:
CreateConsigneeRequest:
type: object
properties:
name:
type:
- string
- 'null'
certificateName:
type:
- string
- 'null'
uf:
type:
- string
- 'null'
agencies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AgenciesRequest'
additionalProperties: false
CreateConsigneeResponse:
required:
- status
type: object
properties:
consigneeId:
type: string
format: uuid
agencies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CreateAgenciesResponse'
status:
type:
- string
- 'null'
additionalProperties: false
CreditProviderType:
enum:
- SIAPE
- CT
- FGTS
- INSS
- ECONSIG_ARMY
- FACIL_PI
type: string
UpdateRubricConfigRequest:
type: object
properties:
code:
type:
- string
- 'null'
description:
type:
- string
- 'null'
partnerCode:
type:
- string
- 'null'
serviceCode:
type:
- string
- 'null'
typeProduct:
$ref: '#/components/schemas/TypeProduct'
exclude:
type: boolean
additionalProperties: false
UpdateAgenciesResquest:
type: object
properties:
agencyId:
type:
- string
- 'null'
format: uuid
code:
type:
- string
- 'null'
password:
type:
- string
- 'null'
user:
type:
- string
- 'null'
agencyType:
$ref: '#/components/schemas/CreditProviderType'
apiKey:
type:
- string
- 'null'
registrationName:
type:
- string
- 'null'
rubricConfigs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UpdateRubricConfigRequest'
additionalProperties: false
RubricConfigResponse:
type: object
properties:
code:
type:
- string
- 'null'
description:
type:
- string
- 'null'
partnerCode:
type:
- string
- 'null'
serviceCode:
type:
- string
- 'null'
typeProduct:
$ref: '#/components/schemas/TypeProduct'
additionalProperties: false
ClientResponse:
type: object
properties:
clientId:
type:
- string
- 'null'
localId:
type:
- string
- 'null'
userId:
type:
- string
- 'null'
additionalProperties: false
RubricConfigRequest:
type: object
properties:
code:
type:
- string
- 'null'
description:
type:
- string
- 'null'
partnerCode:
type:
- string
- 'null'
serviceCode:
type:
- string
- 'null'
typeProduct:
$ref: '#/components/schemas/TypeProduct'
additionalProperties: false
CreateAgenciesResponse:
type: object
properties:
agencyId:
type: string
format: uuid
name:
type:
- string
- 'null'
additionalProperties: false
AgenciesRequest:
type: object
properties:
code:
type:
- string
- 'null'
password:
type:
- string
- 'null'
user:
type:
- string
- 'null'
agencyType:
$ref: '#/components/schemas/CreditProviderType'
apiKey:
type:
- string
- 'null'
registrationName:
type:
- string
- 'null'
rubricConfigs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RubricConfigRequest'
additionalProperties: false
ConsigneeResponse:
type: object
properties:
consigneeId:
type: string
format: uuid
name:
type:
- string
- 'null'
certificateName:
type:
- string
- 'null'
uf:
type:
- string
- 'null'
client:
$ref: '#/components/schemas/ClientResponse'
agencies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AgenciesResponse'
additionalProperties: false
AgenciesResponse:
type: object
properties:
agencyId:
type: string
format: uuid
code:
type:
- string
- 'null'
password:
type:
- string
- 'null'
user:
type:
- string
- 'null'
name:
type:
- string
- 'null'
apiKey:
type:
- string
- 'null'
registrationName:
type:
- string
- 'null'
rubricConfigs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RubricConfigResponse'
updateAt:
type:
- string
- 'null'
format: date-time
additionalProperties: false
TypeProduct:
enum:
- LOAN
- CARD_CREDIT
- CARD_BENEFICIARY
- MONTHLY_DESC
- SYNDICAL_DESC
- PORTABILITY
type: string
DeleteConsigneeResponse:
type: object
properties:
consigneeId:
type: string
format: uuid
name:
type:
- string
- 'null'
certificateName:
type:
- string
- 'null'
uf:
type:
- string
- 'null'
client:
$ref: '#/components/schemas/ClientResponse'
agency:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AgenciesResponse'
additionalProperties: false
UpdateConsigneeRequest:
required:
- consigneeId
type: object
properties:
consigneeId:
type: string
format: uuid
name:
type:
- string
- 'null'
certificateName:
type:
- string
- 'null'
uf:
type:
- string
- 'null'
agencies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UpdateAgenciesResquest'
additionalProperties: false
securitySchemes:
Bearer:
type: http
description: Autenticação utilizando JTW Bearer Token
scheme: Bearer
bearerFormat: JWT