Incluir Reivindicação de Chave de Endereçamento

Importante:

Para usar esta API, é necessário estar autenticado e incluir seu token de autenticação no cabeçalho da requisição. Consulte a documentação de Autenticação na plataforma para mais informações.

Autenticação.

O Sistema Cliente utiliza essa API para iniciar um processo de Reivindicação de uma Chave de Endereçamento.

Se, ao tentar incluir uma Chave de Endereçamento, houver um erro indicando que a chave já existe no DICT, o cliente pode solicitar uma Reivindicação de Chave de Endereçamento. Se a chave existente estiver associada ao mesmo CPF/CNPJ do cliente, a reivindicação será do tipo Portabilidade. Caso contrário, será uma Reivindicação de Posse.

Não é possível reivindicar uma chave do tipo EVP (Endereço Virtual de Pagamento), pois seu valor não possui significado semântico. Nesse caso, o Cliente deve gerar uma nova chave EVP ao invés de iniciar um processo de Reivindicação.

O processo de Reivindicação segue estes passos:

• O Cliente Reivindicador inclui a Reivindicação, com situação "Aberta".

• O Cliente Doador, que possui a posse da chave, tem um prazo para ler a Reivindicação. Uma vez lida, a Reivindicação passa para a situação "Aguardando Resolução", e o Cliente Doador decide se aceita ceder a chave ou não.

• Tanto o Cliente Doador quanto o Cliente Reivindicador podem cancelar a Reivindicação, alterando sua situação para "Cancelada".

• Se o Cliente Doador concordar em ceder a chave, a situação é alterada para "Confirmada".

• Quando o Cliente Reivindicador registra a situação "Concluída", o DICT assume que o processo foi aceito por ambas as partes e vincula a chave ao Cliente Reivindicador.

Após validar a reivindicação, o JDPI a enviará ao DICT. Em caso de sucesso, o JDPI armazenará a reivindicação em sua base local, com a situação "Aberta".

Como utilizar?

Para utilizar essa funcionalidade, siga estes passos simples. Abaixo, você encontrará exemplos de como realizar o processo de abertura de conta.

Requisição de exemplo

Solicitar

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"claimType":"PORTABILIDADE","keyType":"E_MAIL","key":"[email protected]","ispb":11165756,"agency":"0001","accountType":"CONTA_CORRENTE","account":"0007654321","dtHrOpenAccount":"2020-01-10T11:30:17.001Z","peopleType":"JURIDICA","cpfCnpj":4358798000107,"businessName":"Empresa de Tal","tradingName":"Empresa Recebedora"}

Responses

200

successful

No content

401

authorization failed

422

validation failed

500

unknown server error

post

https://sandbox.globalscm.app.br/internal/api/v1/claims

HTTPcURLJavaScriptPython

POST https://sandbox.globalscm.app.br/internal/api/v1/claims HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "claimType": "PORTABILIDADE",
  "keyType": "E_MAIL",
  "key": "[email protected]",
  "ispb": 11165756,
  "agency": "0001",
  "accountType": "CONTA_CORRENTE",
  "account": "0007654321",
  "dtHrOpenAccount": "2020-01-10T11:30:17.001Z",
  "peopleType": "JURIDICA",
  "cpfCnpj": 4358798000107,
  "businessName": "Empresa de Tal",
  "tradingName": "Empresa Recebedora"
}

No content

JSON Retorno Sucesso