v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cadastrar usuário

Essa API permite realizar o cadastro de um usuário no DDA para recebimento das notificações de boletos gerados em seu documento (CPF/CNPJ). Veja nosso artigo e saiba como realizar a implementação dessa API.

Em ambiente de teste (sandbox) pode ser usado qualquer documento, mas o tempo de retorno dos webhooks pode demorar. Se quiser simular o retorno dos webhooks de forma rápida, utilize nossos dados armazenados previamente. Para isso, basta usar o CPF 71929784007 para simular um cadastro com sucesso ou o CPF 26817625025 para simular um cadastro com erro.

Para testar as notificações de boletos, basta informar qualquer CNPJ ou CPF cadastrados (status created) anteriormente (com exceção dos CPFs armazenados, citados anteriormente) na API de boletos.

post/dda-subscription-webservice/v1/subscription/Register

Request body

documentstring required

Documento do usuário (CPF ou CNPJ) que deverá ser registrado no DDA. Não usar pontos e traços.

clientNamestring required

Nome do usuário que deverá ser registrado no DDA.

clientRequestIdstring

Identificador da requisição, fornecida pelo cliente. Sugerimos que envie valores diferentes para cada solicitação

Response

201

statusinteger

Example response

{
  "status": 201,
  "body": {
    "document": "23155663049",
    "clientRequestId": "0001",
    "responseDate": "2022-11-17T14:03:06.4688394+00:00",
    "status": "PROCESSING",
    "subscriptionId": "bfacff76-de86-4b8d-9797-4ea565b4f60d"
  }
}