Get Business Data API
Used for registering a business outside of the DOKU Dashboard. Partners can use this API to create an account and provide their business information, including legal name, address, and contact information. After uploading the necessary documents using the API Upload Document, partners can input their business information in this component.
Endpoint
Type | Value |
---|---|
HTTP Method | GET |
API endpoint (Test Mode) |
|
API endpoint (Production) |
|
Request Header
Parameter | Description |
---|---|
| Client ID (Brand ID) will be shared by DOKU Account Manager |
| Unique random string (max 128 characters) generated from merchant side to protect duplicate request |
| Timestamp request on UTC time in ISO8601 UTC+0 format. It means to proceed transaction on UTC+7 (WIB), merchant need to subtract time with 7. Ex: to proceed transaction on September 22th 2020 at 08:51:00 WIB, the timestamp should be 2020-09-22T01:51:00Z |
| Security parameter that needs to be generated on merchant Backend and placed to the header request to ensure that the request is coming from valid merchant. Please refer to this section to generate the signature |
Request Parameters
Query Params | Type | Mandatory | Description |
---|---|---|---|
|
| Mandatory | e.g. PERSONAL, CORPORATE |
|
| Mandatory | e.g. PT, CV, etc. (Possible Values) |
|
| Mandatory | e.g. RETAIL, DIGITAL_AND_GAME, etc. (Possible Values) |
|
| Mandatory | e.g. ID (ISO2 CODE) |
Possible Values
Parameter | Possible Values |
---|---|
| PERSONAL |
| PERSEORANGAN |
|
|
| ID |
Response Sample
Response Explanation
Parameter | Data Type | Possible Value |
---|---|---|
id | ANS(22) | BSN-0102-1676676916608 |
name | ANS(225) | Business under partner personal to check partner identifier CRM |
description | ANS(255) | Description test untuk personal partner CRM DOKU |
ANS(30) | jasmine_partnercrm@doku.com | |
phone_calling_code | ANS(320) | 62 |
phone_number | ANS(320) | 815107283011 |
partner | ANS(22) | BRN-0201-1676357010382 |
platform | ANS(255) | api |
type | ANS(22) | PERSONAL |
website_readiness.code | ANS(22) | HAVE |
website_readiness.value | ANS(22) | Have a website |
mobile_app_readiness.code | ANS(255) | UNDER_DEVELOPMENT |
mobile_app_readiness.value | ANS(22) | Under Development |
legal_entity.code | ANS(22) | PERSEORANGAN |
legal_entity.name | ANS(255) | Personal |
brands.id | ANS(50) | BRN-0104-1678960841263 |
brands.name | ANS(22) | Brand under partner personal only test |
brands.share_key | ANS(255) | SK-ViEeAojc5K0nBrL41ou4 |
brands.category | ANS(255) | NON_RETAIL |
brands.minimum_transaction | ANS(10) | 0 |
brands.maximum_transaction | ANS(255) | 100 |
brands.transaction_frequency.code | ANS(255) | UMI |
brands.transaction_frequency.name | ANS(10) | < IDR 20 Mio |
brands.transaction_quantity.code | ANS(10) | UP_TO_100 |
brands.transaction_quantity.name | ANS(10) | < 100 |
brands.ticket_size.code | ANS(10) | UP_TO_50K |
brands.ticket_size.name | ANS(50) | Less than or equal to IDR 50.000 |
brands.finance_status | ANS(50) | PROBATION |
brands.risk_engine_status | ANS(50) | ON_PROCESS |
brands.photo_proofs.id | ANS(50) | PHP-0113-1678960841279 |
brands.photo_proofs.photo | ANS(255) | |
brands.photo_proofs.rejected | boolean | false |
brands.photo_proofs.notified | boolean | true |
brands.photo_proofs.approval_uuid | AN(128) | 7e90d35b-dae6-40cb-9aae-6effdec3f3ac |
brands.photo_proofs.status | ANS(50) | UPDATING |
AN(128) | SCM-0108-1678960841279 | |
ANS(50) | ||
ANS(50) | ||
brands.social_media.account | ANS(50) | |
brands.social_media.rejected | boolean | false |
brands.social_media.notified | boolean | true |
brands.social_media.approval_uuid | AN(128) | 0932625e-8e04-44c3-bb37-36279559e7c0 |
brands.social_media.status | ANS(50) | UPDATING |
AN(128) | PRD-0138-1678960841304 | |
brands.products.code | ANS(50) | ONLINE_TO_OFFLINE_ALFA_AGGREGATOR |
brands.products.name | ANS(50) | Alfa Group (Aggregator) |
brands.products.description | ANS(255) | Accept payments at Alfamart, Alfamidi, Dan+Dan, and Lawson outlets. Your customer will make payment using DOKU's name. |
brands.products.rejected | boolean | false |
brands.products.notified | boolean | true |
brands.products.approval_uuid | AN(128) | 5b4e4539-042e-4c27-a71b-cb8d6d4ddd0f |
brands.products.status | ANS(50) | ACTIVE |
brands.audit_logs |
| [[]] |
brands.authorized | boolean | true |
brands.rejected | boolean | false |
brands.notified | boolean | true |
brands.approval_uuid | AN(128) | 3e07befa-6657-448c-aae5-09c6e3d02b6c |
brands.status | ANS(50) | UPDATING |
brands.description | ANS(255) | Description test untuk brand |
brands.created_date | date | 2023-03-16T10:00:41Z |
contacts.id | AN(128) | CNT-0112-1678960841579 |
contacts.name | ANS (50) | contact jasmine under partner ke 2 |
contacts.email | ANS (50) | business_contact+1@doku.com |
contacts.phone_calling_code | Numeric | 62 |
contacts.phone_number | Numeric | 8191029 |
contacts.liveness_image | AN(128) | |
ANS (50) | OWNER | |
contacts.position.name | ANS (50) | Owner |
contacts.nationality.code | ANS (10) | ID |
contacts.nationality.name | ANS (10) | Indonesia |
contacts.liveness_factor.code | ANS (10) | SHOW_TWO |
ANS (50) | show number 2 with finger without covering your face | |
contacts.use_primary | boolean | true |
contacts.rejected | boolean | false |
contacts.notified | boolean | true |
contacts.approval_uuid | AN(128) | 6f4a42b4-d078-4712-b950-51aa284744a6 |
contacts.status | ANS (50) | UPDATING |
addresses.id | AN(128) | ADR-0111-1678960841481 |
addresses.name | ANS (255) | Jalan raya kaliabang tengah no 78, bekasi utara |
addresses.area.code | ANS (50) | 17133 - Kali Baru - Medan Satria - Bekasi - Jawa Barat |
addresses.country.code | ANS (10) | ID |
addresses.country.name | ANS (50) | Indonesia |
addresses.use_primary | boolean | true |
addresses.rejected | boolean | false |
addresses.notified | boolean | true |
addresses.approval_uuid | AN(128) | f4b11369-927f-4b52-a76a-3b45ec44b164 |
addresses.status | ANS (50) | UPDATING |
documents.id | AN(128) | DCM-0117-1678960841601 |
documents.relation | AN(128) | CNT-0112-1678960841579 |
documents.link | AN(128) | |
documents.document.code | ANS(50) | KTP |
documents.document.name | ANS(50) | Kartu Tanda Penduduk |
documents.forms.code | ANS(10) | NO_KTP |
documents.forms.name | ANS(50) | KTP No. (NIK) |
documents.forms.value | Numeric | 1234567890123456 |
documents.rejected | boolean | false |
documents.notified | boolean | true |
documents.approval_uuid | AN(128) | 21d836d9-345b-4b20-989b-993469d7ec87 |
documents.status | ANS (50) | UPDATING |
banks.id | AN (128) | BNK-0103-1678960841495 |
banks.bank_id | AN(128) | 4 |
banks.bank_name | AN(128) | BANK BCA |
banks.swift_code | AN(128) | 014 |
banks.account_name | ANS (50) | Jasmine Test QA |
banks.account_number | AN(128) | 12345058 |
banks.documents |
| [[]] |
banks.country.code | ANS (50) | ID |
banks.country.name | ANS (50) | Indonesia |
banks.currency.code | ANS (50) | IDR |
banks.currency.name | ANS (50) | Indonesian rupiah |
banks.rejected |
| false |
banks.notified |
| true |
banks.approval_uuid | ANS (50) | 1c6d3599-51ec-406a-8cfb-fd6b96a8269a |
banks.status | ANS (50) | UPDATING |
step_number | AN(128) | 10 |
rejected |
| false |
notified |
| true |
approval_id | AN(128) | 0fe9de0c-1879-4a32-a6a1-935043a2c648 |
status | ANS (50) | UPDATING |
Response Example (JSON)
Last updated