Address Management

Navigation

• Documents and Signature (previous)

During the Onboarding and KYC process, the beneficiary's address is validated both by our analysis processes and by the beneficiary themselves. If any inconsistency is detected, the client will be notified to confirm or correct the data with the beneficiary.

1. Address validation error webhook

This webhook is triggered when the KYC process identifies inconsistencies between the submitted address and the address in our database.

Action Required

Upon receiving this webhook, the client must contact the beneficiary and request data correction through the Address Update endpoint. Failure to execute this correction may result in card delivery failures

WEBHOOK TYPE

laas.payroll_card_reservation.address

Webhook Body

{
    "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "webhook_type": "laas.payroll_card_reservation.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. Address Update

Endpoint used to correct the beneficiary's address after receiving an address validation error webhook.

info

If the beneficiary confirms the address, it is not necessary to send an address update request, and the already registered address will be used for card delivery.

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

Field	Type	Description	Required
city	string	City	Yes
state	string	State (UF)	Yes
number	string	Number	Yes
street	string	Street	Yes
complement	string	Complement	No
postal_code	string	Postal Code (numbers only)	Yes
neighborhood	string	Neighborhood	Yes

Response

STATUS

200 (OK)

The operation will be automatically reprocessed in the KYC flow, potentially resulting in a new error webhook if any inconsistency is detected again.