Skip to main content

Get Merchant by ID

GET 
/v1/users/merchant-onboarding/:id

Retrieves merchant details by ID. Returns merchant onboarding data stored in the system.

Request​

Path Parameters

    id stringrequired

    Merchant 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

    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​

Merchant retrieved successfully.

Schema
    id stringrequired

    Merchant onboarding ID.

    status stringrequired

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

    Merchant onboarding status.

    external_id string

    External merchant ID.

    merchant_id string

    Merchant ID (MID) for synchronization with authorizers.

    trade_name stringrequired

    Trade name.

    name stringrequired

    Merchant name.

    document_id stringrequired

    Document ID.

    corporate_name stringrequired

    Corporate name.

    email stringrequired

    Email.

    area_code stringrequired

    Area code.

    number stringrequired

    Phone number.

    phone_type stringrequired

    Possible values: [C, P]

    Phone type.

    timezone stringrequired

    Establishment timezone. Format: +0300, -0300 (without colon).

    active booleanrequired

    Is active.

    contacts object[]required

    Contacts list.

  • Array [
    • name stringrequired

    Contact name.

    document_id stringrequired

    Contact document ID.

    email stringrequired

    Contact email.

    area_code stringrequired

    Contact area code.

    number stringrequired

    Contact number.

    phone_type stringrequired

    Possible values: [C, P]

    Phone type.

    birth_date string

    Birth date (YYYY-MM-DD).

    is_partner_contact booleanrequired

    Is partner contact.

    is_pep booleanrequired

    Is PEP.

  • ]
    • risk_analysis_status stringrequired

    Possible values: [WAITING_DOCUMENTS, PENDING, APPROVED, DECLINED, KYCOFFLINE, NOT_ANALYSIS]

    Risk analysis status.

    risk_analysis_status_justification string

    Risk analysis status justification.

    opening_date string

    Opening date (YYYY-MM-DD).

    opening_days stringrequired

    Opening days.

    opening_hour stringrequired

    Opening hour.

    closing_hour stringrequired

    Closing hour.

    municipal_registration string

    Municipal registration.

    state_subscription string

    State subscription.

    has_tef booleanrequired

    Has TEF.

    has_pix booleanrequired

    Has PIX.

    has_top booleanrequired

    Has TOP.

    has_3ds booleanrequired

    Has 3DS.

    establishment_format stringrequired

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

    Establishment format.

    revenue number

    Revenue.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

    legal_nature_code string

    Legal nature code.

Loading...