Skip to main content

List Company Registrations.

GET 
/v1/users/company-registrations

Tag: api-baas-get-all-company-registration

Description: Retrieve a list of company registrations with optional filters.

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: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    status string

    Possible values: [PENDING, SUBMITTED, WAITING_DOCUMENTS, APPROVED, DECLINED, FAILED]

    Company registration status.

    cnpj string

    Company CNPJ.

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​

Company registrations returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Company registrations data.

  • Array [
    • id stringrequired

    Company registration ID.

    cnpj stringrequired

    Company CNPJ.

    status stringrequired

    Possible values: [PENDING, SUBMITTED, WAITING_DOCUMENTS, APPROVED, DECLINED, FAILED]

    Company registration status.

    opening_date date-time

    Company opening date (ISO 8601 date-time).

    revenue number

    Company revenue.

    establishment_format string

    Possible values: [EI, MEI, EIRELI, LTDA, SS, SA, ME, EPP, EMPG, COOP, OTHER]

    Establishment format.

    state_registration string

    State registration.

    partner_changed boolean

    Whether partners changed.

    bank_number string

    Bank number.

    bank_account_status string

    Possible values: [ACTIVE, NOT_ACTIVE, PENDING, LOCKED, CLOSED]

    Bank account status.

    alias_created_date string

    Alias bank account creation date.

    failed_code string

    Failed error code.

    failed_message string

    Failed error message.

    status_reason stringrequired

    Possible values: [REGISTRATION_CREATED, WAITING_DOCUMENTS_SUBMISSION, UNDER_REVIEW, ALIAS_ACCOUNT_PENDING, ALIAS_ACCOUNT_ACTIVE, ALIAS_ACCOUNT_NOT_ACTIVE, ALIAS_ACCOUNT_LOCKED, ALIAS_ACCOUNT_CLOSED, ALIAS_ACCOUNT_UNKNOWN_STATUS, REGISTRATION_DECLINED, REGISTRATION_FAILED]

    Detailed reason that explains why the registration is in the current status.

    next_action stringrequired

    Possible values: [WAIT_SUBMISSION, UPLOAD_DOCUMENTS, WAIT_REVIEW, WAIT_ALIAS_ACCOUNT, CONTACT_SUPPORT, RETRY, NONE]

    Next action required to continue or complete the company registration process.

    is_operational booleanrequired

    Indicates whether the company registration is operational and ready to use.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

  • ]
Loading...