Skip to main content

Get Legal Person Onboarding by ID

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

Get legal person onboarding by ID for the authenticated user.

Request​

Path Parameters

    id stringrequired

    Legal person onboarding ID.

Header Parameters

    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.

Responses​

The legal person onboarding returned successfully.

Schema
    id stringrequired

    Onboarding ID.

    legal_person_name stringrequired

    Legal person name.

    cnpj stringrequired

    Legal person CNPJ.

    status stringrequired

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

    Onboarding Status.

    address object
    id objectrequired

    User address ID.

    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 company revenue in R$ cents.

    created_at date-timerequired

    Onboarding Created at.

Loading...