Skip to main content

Update Legal Person Onboarding

PUT 
/v1/users/onboardings/legal-person/:id

Update an onboarding for legal person (PJ) account. You can update the headquarters or branch address and company revenue (faturamento).

Request​

Path Parameters

    id stringrequired

    Legal person onboarding ID.

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Body

required
    address object
    zip_code objectrequired

    User address zip code.

    street objectrequired

    User address street.

    number objectrequired

    User address number.

    neighborhood object

    User address neighborhood.

    city objectrequired

    User address neighborhood.

    federative_unit objectrequired

    User address federative unit.

    country objectrequired

    User address country.

    complement object

    User address complement.

    company_revenue number

    Legal person annual revenue in R$ cents.

Responses​

Legal person onboarding updated successfully.

Schema
    id stringrequired

    Onboarding ID.

    status stringrequired

    Possible values: [pending, finished, failed, expired]

    Onboarding Status. The status will be PENDING until the corporate structure (quadro societário) is completed.

    created_at date-timerequired

    Onboarding Created at.

    updated_at date-time

    Onboarding Updated at.

Loading...