Skip to main content

Get User Account by ID

GET 
/v1/users/accounts/:id

Get an user account by id.

Request​

Path Parameters

    id stringrequired

    User account 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 stringrequired

    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​

User account returned.

Schema
    id objectrequired

    User account ID.

    state stringrequired

    Possible values: [pending, active, expired, deactivated]

    User state.

    name objectrequired

    User short name or company trade name.

    full_name objectrequired

    User full name or company name.

    genre object

    User gender.

    mother_name object

    User mother name.

    birth_date object

    User birth date.

    document objectrequired

    User CPF or company CNPJ.

    phone_number objectrequired

    User or company phone number.

    email objectrequired

    User or company e-mail.

    active objectrequired

    User should start as active?

    person_type objectrequired

    Person type:

    • NATURAL_PERSON.
    • LEGAL_PERSON.

    legal_person_type object

    Legal type:

    • EI.
    • LTDA.
    • MEI.
    • SA.
    • SLU.
    • SS.

    created_at date-timerequired

    User created date.

    updated_at date-timerequired

    User updated date.

Loading...