Portal de APIsCadastro de Beneficiário

Cadastro de Beneficiário

API para cadastro e atualização de beneficiários com dados completos de endereço e informações bancárias

Base URL: https://dev-api.albatrozmga.com/claim/v2

Versão:

v2.0

Categoria:

Sinistros

Cadastrar Beneficiário

Cria ou atualiza registro de beneficiário com endereços e dados bancários. Sempre busque o beneficiário antes de tentar cadastrar para evitar duplicatas.

POST

POST https://dev-api.albatrozmga.com/claim/v2/partner-claim/register-beneficiary

Headers

Authorization

string

Obrigatório

Token de autenticação Bearer

Exemplo: "Bearer eyJhbGciOiJIUzI1NiIs..."

Content-Type

string

Obrigatório

Tipo do conteúdo da requisição

Exemplo: "application/json"

Corpo da Requisição

nome

string

Obrigatório

Nome completo ou razão social do beneficiário

Exemplo: "CALMAC VEICULOS LTDA"

cpfCnpj

string

Obrigatório

CPF ou CNPJ do beneficiário (apenas números)

Exemplo: "04282593000187"

enderecos

array

Obrigatório

Lista de endereços do beneficiário. Ao menos um endereço deve ter enderecoPadrao = true

cep

integer

Obrigatório

CEP sem formatação (apenas números)

Exemplo: 5477000

codigoUf

integer

Obrigatório

Código numérico do estado (UF)

Exemplo: 1

codigoPais

integer

Obrigatório

Código do país (1 = Brasil)

Exemplo: 1

cidade

string

Obrigatório

Nome da cidade

Exemplo: "São Paulo"

bairro

string

Obrigatório

Nome do bairro

Exemplo: "Centro"

logradouro

string

Obrigatório

Nome da rua/avenida

Exemplo: "AV NACOES UNIDAS"

numero

string

Obrigatório

Número do imóvel

Exemplo: "65"

complemento

string

Complemento do endereço (apartamento, sala, etc.)

Exemplo: "Cj 71"

enderecoPadrao

boolean

Obrigatório

Define se é o endereço principal. Pelo menos um deve ser true.

Exemplo: true

codigoTipoEndereco

integer

Obrigatório

Tipo do endereço (1=Residencial, 2=Comercial, 3=Correspondência, 4=Cobrança)

Exemplo: 2

dadosBancarios

array

Obrigatório

Lista de contas bancárias do beneficiário. Ao menos uma conta deve ter principal = true

numeroBanco

integer

Obrigatório

Código do banco brasileiro (3 dígitos)

Exemplo: 237

descricao

string

Obrigatório

Nome do banco

Exemplo: "Banco Bradesco S.A."

agencia

integer

Obrigatório

Número da agência

Exemplo: 3391

digitoAgencia

integer

Obrigatório

Dígito verificador da agência

Exemplo: 1

numeroConta

integer

Obrigatório

Número da conta bancária

Exemplo: 77890

digitoConta

integer

Obrigatório

Dígito verificador da conta

Exemplo: 7

codigoTipoConta

integer

Obrigatório

Tipo da conta bancária (1=Corrente, 2=Poupança, 3=Salário)

Exemplo: 1

principal

boolean

Obrigatório

Define se é a conta bancária principal para pagamentos. Pelo menos uma deve ser true.

Exemplo: true

ativa

boolean

Obrigatório

Indica se a conta está ativa para recebimentos

Exemplo: true

codigoMeioPagamento

integer

Obrigatório

Código do meio de pagamento (3=TED Outros Bancos, 4=TED Itaú)

Exemplo: 3

Informações

Base URL

https://dev-api.albatrozmga.com/claim/v2

Versão

v2.0

Categoria

Sinistros

Gerenciador de Tabelas de Domínio

Visualize e gerencie as tabelas de domínio utilizadas nas APIs

Ações Rápidas