Get User Account

GET 
/v1/users/accounts

Get all user accounts related to the user.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [id, document, name, fullName, active, state, created_at]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

search string

Possible values: non-empty and <= 50 characters

Search filter. This filter is used to search for user account info.

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

200

User accounts returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Onboarding data.
Array [
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.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "state": "active",
      "name": {},
      "full_name": {},
      "genre": {},
      "mother_name": {},
      "birth_date": "1984-11-03",
      "document": {},
      "phone_number": "5511955551234",
      "email": "new-user@zrobank.com.br",
      "active": {},
      "person_type": "LEGAL_PERSON",
      "legal_person_type": "LTDA",
      "created_at": "2025-03-11T19:15:54.244Z"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Loading...