Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Type Alias BRShopOnboardingInfo

    BR shop onboarding information

    type BRShopOnboardingInfo = {
        billing_address?: BillingAddress;
        birthday?: number;
        birthday_str?: string;
        cnae_main?: string;
        cnae_secondary?: string;
        cnpj_id?: string;
        cpf_id?: string;
        legal_entity_name?: string;
        mei_check?: string;
        name?: string;
        nationality?: string;
        onboarding_passed?: boolean;
        onboarding_status?: number;
        state_registration?: string;
        submission_time?: number;
        tax_id?: string;
        tax_id_type?: number;
    }
    Index

    Properties

    billing_address? birthday? birthday_str? cnae_main? cnae_secondary? cnpj_id? cpf_id? legal_entity_name? mei_check? name? nationality? onboarding_passed? onboarding_status? state_registration? submission_time? tax_id? tax_id_type?

    Properties

    billing_address?: BillingAddress

    Shop's billing address details

    birthday?: number

    Birthday of the individual seller (stored as Unix timestamp). Valid only when tax_id_type = 1.

    birthday_str?: string

    Birthday of the individual seller (formatted as YYYY-MM-DD). Valid only when tax_id_type = 1.

    cnae_main?: string

    Main CNAE code

    cnae_secondary?: string

    Secondary CNAE code

    cnpj_id?: string

    CNPJ number of the company seller. Valid only when tax_id_type = 2.

    cpf_id?: string

    CPF number of the individual seller. Valid only when tax_id_type = 1.

    legal_entity_name?: string

    Legal name of the company seller. Valid only when tax_id_type = 2.

    mei_check?: string

    MEI verification result. 0: No, 1: Yes

    name?: string

    Full name of the individual seller. Valid only when tax_id_type = 1.

    nationality?: string

    Nationality of the individual seller. Valid only when tax_id_type=1.

    onboarding_passed?: boolean

    Indicate if the shop has passed KYC verification

    onboarding_status?: number

    Status of the shop's current KYC onboarding process. 0: None, 1: Regis Processing, 2: Regis Validated, 3: Regis Rejected, 4: KYC Pending, 5: KYC Processing, 6: KYC Processing Manually, 7: KYC Validated, 8: KYC Rejected

    state_registration?: string

    State registration number of the shop

    submission_time?: number

    Timestamp when the onboarding information was submitted

    tax_id?: string

    The shop's tax ID. When tax_id_type = 1 (Personal seller), it is CPF. When tax_id_type = 2 (Company seller), it is CNPJ.

    tax_id_type?: number

    Type of the shop's tax ID. 1: Personal seller (CPF), 2: Company seller (CNPJ)

    Settings

    Member Visibility

    On This Page

    Properties