Skip to main content

Create Legal Person Onboarding

POST 
/v1/users/onboardings/legal-person

Creates a legal person onboarding record in PENDING status.

Related endpoints commonly used with this resource:

  • POST /users/onboardings/legal-person (this endpoint)
  • POST /users/shareholders
  • POST /users/legal-representatives (linked by shareholder_id)
  • POST /users/legal-representatives/{id}/documents for all representatives
  • POST /users/onboardings/legal-person/{id}/documents for legal person documents
  • POST /users/onboardings/legal-person/{id}/finalize

Prerequisite: the user has already been created via /users/accounts.

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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires 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 city.

    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 created successfully. Status is PENDING.

Schema
    id stringrequired

    Legal person onboarding ID.

    status stringrequired

    Possible values: [pending, invalid, in_process, approved, rejected, finished, expired, failed, in_process_delayed]

    Onboarding status. The initial status is PENDING until onboarding is finalized.

    created_at date-timerequired

    Onboarding Created at.

Loading...