Skip to main content

Create Legal Person Onboarding (Step 1 of 5)

POST 
/v1/users/onboardings/legal-person

Step 1: Create the legal person onboarding. This is the first step in the legal person (PJ) onboarding flow. After creating, the status will be PENDING until all steps are completed.

Complete onboarding flow:

  1. POST /legal-person - Create onboarding (this endpoint)
  2. POST /legal-representative - Add legal representatives (partners/administrators)
  3. POST /legal-representative/{id}/documents - Upload representative documents (selfie, identity, qualification)
  4. POST /legal-person/{id}/documents - Upload company documents (social_contract + balance_sheet OR revenue_statement)
  5. POST /legal-person/{id}/finalize - Finalize onboarding (status changes to IN_PROCESS)

Request​

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 objectrequired
    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 numberrequired

    Legal person annual revenue in R$ cents.

Responses​

Legal person onboarding created successfully. Status is PENDING. Proceed to add legal representatives.

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.

Loading...