Gestão de Endereço

Durante o processo de Onboarding e KYC, o endereço do beneficiário é validado tanto por nossos processos de análise quanto pelo próprio beneficiário. Caso alguma inconsistência seja detectada, o cliente será notificado para realizar a confirmação ou a correção dos dados junto ao beneficiário.

1. Webhook de erro na validação do endereço

Este webhook é disparado quando o processo de KYC identifica inconsistências entre o endereço enviado e o endereço em nossa base.

Ação Necessária

Ao receber este webhook, o cliente deve contatar o beneficiário e solicitar a correção dos dados através do endpoint de Atualização de Endereço. A não execução desta correção pode resultar em falhas na entrega do cartão

WEBHOOK TYPE

laas.payroll_card.onboarding.address

Webhook Body

{
    "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "webhook_type": "laas.payroll_card.onboarding.address",
    "status": "pending_card_issuance",
    "event_datetime": "2025-01-15T16:45:00Z",
    "data": {
        "address": {
          "city": "Belo Horizonte",
          "state": "MG",
          "postal_code": "30112000",
          "street": "Rua Inexistente",
          "number": "000",
          "neighborhood": "Savassi"
        }, 
        "rejected_reason": "address_validation_failed",
        "rejection_details": {
            "description": "Endereço não encontrado na base de validação"
        }
    }
}

---

2. Atualização de Endereço

Endpoint utilizado para corrigir o endereço do beneficiário após o recebimento de um webhook de erro de validação.

info

Caso o beneficiário confirme o endereço, não é necessário enviar uma requisição de atualização de endereço, e o endereço já cadastrado será utilizado para o envio do cartão.

Request

PATCH

/payroll_card_reservation/social_security/{payroll_card_reservation_key}/address

Request Body

{
    "address": {
        "city": "Belo Horizonte",
        "state": "MG",
        "number": "789",
        "street": "Rua das Palmeiras",
        "complement": "Casa 3",
        "postal_code": "30112000",
        "neighborhood": "Savassi"
    }
}

Params Details

Campo	Tipo	Descrição	Obrigatório
city	string	Cidade	Sim
state	string	Estado (UF)	Sim
number	string	Número	Sim
street	string	Logradouro	Sim
complement	string	Complemento	Não
postal_code	string	CEP (apenas números)	Sim
neighborhood	string	Bairro	Sim

Response

STATUS

200 (OK)

A operação será automaticamente reprocessada no fluxo de KYC, potencialmente resultando em um novo webhook de erro caso seja detectada alguma inconsistência novamente.