1. Cadastro do cedente
HubDE
  • Instruções Gerais
    • Como começar
  • Integração para ERPs e Portais do Cedente
    • Integração para ERPs e Portais do Cedente
    • Cadastro do cedente
      • Cria a sessão de cadastro do cedente
        POST
      • Cria a sessão de acompanhamento
        POST
      • Consulta o cliente da credencial
        GET
      • Lista as escrituradoras disponíveis
        GET
    • Duplicatas
      • Envia as duplicatas de uma operação
      • Consulta o desfecho das duplicatas
      • Informa a liquidação de títulos
    • Acompanhamento
      • Consulta a situação dos cedentes
  1. Cadastro do cedente

Cria a sessão de cadastro do cedente

POST
/erp/v1/sessoes-onboarding
Cria a sessão de onboarding. A resposta é uma url de uso único, com prazo:
abra-a no navegador do operador.
Reenviar o mesmo cedente é caso normal. Se o operador percebeu um dado
errado no ERP, corrija-o na origem e crie nova sessão com uma Idempotency-Key inédita: o
cadastro anterior é substituído inteiro e a tela reabre do começo. Isso vale
enquanto o pacote não foi enviado para assinatura. Depois disso o cadastro
já está dentro de um PDF com efeito jurídico e o reenvio é recusado.

Requisição

Authorization
API Key
Adicionar parâmetro em header
X-Api-Key
Exemplo:
X-Api-Key: ********************
or
Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201
application/json
Sessão criada. O header Location acompanha a criação, mas não a repetição idempotente. Use sempre o membro url do corpo.
Headers

Bodyapplication/json

🟠400
🟠409
🟠422
🟠401NaoAutenticada
🟠403Suspensa
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/erp/v1/sessoes-onboarding' \
--header 'Idempotency-Key: 018f3a7c-8e2b-7c4a-9d61-2f5b8c7e4a10' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documentoCedente": "11222333000181",
    "tipoPessoa": "JURIDICA",
    "cadastro": {
        "documento": "11222333000181",
        "tipoPessoa": "JURIDICA",
        "razaoSocial": "METALURGICA SAO JORGE LTDA",
        "origem": {
            "erp": "QPROF",
            "codigoCedenteNoErp": "CED-88231"
        },
        "endereco": {
            "logradouro": "Rua das Indústrias",
            "numero": "450",
            "bairro": "Distrito Industrial",
            "municipio": "Joinville",
            "uf": "SC",
            "cep": "89219500"
        },
        "contato": {
            "email": "contato@saojorge.com.br"
        },
        "representantes": [
            {
                "nome": "Ana Paula Ribeiro",
                "cpf": "11144477735",
                "email": "ana@saojorge.com.br"
            }
        ]
    }
}'
Response Response Example
201 - Exemplo 1
{
    "url": "http://example.com",
    "expiraEm": "2019-08-24T14:15:22.123Z"
}
Modificado em 2026-11-19 11:53:26
Página anterior
Integração para ERPs e Portais do Cedente
Próxima página
Cria a sessão de acompanhamento
Built with