Skip to main content

Get Company Registration by ID.

GET 
/v1/users/company-registrations/:id

Tag: api-baas-get-company-registration-by-id

Description: Retrieves company registration details by ID. Returns company registration data stored in the system.

Request​

Path Parameters

    id stringrequired

    Company registration 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

    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.

Responses​

Company registration retrieved successfully.

Schema
    id stringrequired

    Company registration ID.

    cnpj stringrequired

    Company CNPJ.

    status stringrequired

    Possible values: [WAITING_DOCUMENTS, WAITING_ANALYSIS, WAITING_CORRECTIONS, ACTIVE, DECLINED, CANCELED]

    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

    Possible values: [COMPANY_REGISTRATION_DECLINED, COMPANY_REGISTRATION_CANCELED, GATEWAY_ERROR, LOCAL_PRECONDITION_ERROR]

    Failed error code.

    failed_message object

    Failed error message.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

Loading...