v2.shop.get_br_shop_onboarding_info
GET /api/v2/shop/get_br_shop_onboarding_info
[For BR Shop Only] Use this API to get shop KYC registration and qualification information.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/shop/get_br_shop_onboarding_info
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | ID đối tác được cấp sau khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để xác định thời điểm của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token dùng để truy cập API, xác định quyền của bạn đối với API. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một gian hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Không có Tham số Yêu cầu.
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Cho biết loại lỗi nếu xảy ra lỗi. Rỗng nếu không có lỗi. | |
| message | string | Cho biết chi tiết lỗi nếu xảy ra lỗi. Rỗng nếu không có lỗi. | |
| request_id | string | 6745b892295d750abf83a29430510400 | Mã định danh cho yêu cầu API, dùng để theo dõi lỗi. |
| response | object | Onboarding information of the Shop. | |
| tax_id_type | int32 | Type of the shop’s tax ID. Applicable values: 1: Personal seller (CPF) 2: Company seller (CNPJ) | |
| 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. | |
| cpf_id | string | Số CPF của người bán cá nhân. Chỉ có hiệu lực khi tax_id_type = 1. | |
| cnpj_id | string | Số CNPJ của người bán công ty. Chỉ có hiệu lực khi tax_id_type = 2. | |
| name | string | Full name 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. | |
| birthday | int64 | 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. | |
| state_registration | string | State registration number of the shop. | |
| billing_address | object | Shop’s billing address details. | |
| state | string | State of the billing address. | |
| city | string | City of the billing address. | |
| address | string | Specific detail of the billing address. | |
| zipcode | string | ZIP code of the billing address. | |
| neighborhood | string | Neighborhood of the billing address. | |
| onboarding_status | int32 | Status of the shop’s current KYC onboarding process. Applicable values: 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 | |
| submission_time | int32 | Timestamp when the onboarding information was submitted. | |
| nationality | string | Nationality of the individual seller. Valid only when tax_id_type=1. | |
| cnae_main | string | Main CNAE code. | |
| cnae_secondary | string | Secondary CNAE code. | |
| mei_check | string | MEI verification result. Applicable values: 0: No 1: Yes | |
| onboarding_passed | boolean | Cho biết gian hàng có vượt qua xác minh KYC hay không. |