Business Registration 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

TypeValue

HTTP Method

POST

API endpoint (Test Mode)

https://api-uat.doku.com/adv-core-api/partner/v1.0/business

API endpoint (Production)

https://api.doku.com/adv-core-api/partner/v1.0/business

Request Header

Client-Id: BRN-0001-10791114622547
Request-Id: fdb69f47-96da-499d-acec-7cdc318ab2fe
Request-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=1jap2tpgvWt83tG4J7IhEwUrwmMt71OaIk0oL0e6sPM=
ParameterDescription

client-id

Use Brand ID for Partner

request-id

Unique random string (max 128 characters) generated from merchant side to protect duplicate request

request-timestamp

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

signature

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

{
   "business": {
       "type": "PERSONAL",
       "callback_url": "https://webhook.site/example-url",
       "legal_entity": "PERSEORANGAN",
       "name": "Merchant 26 May",
       "description": "Merchant Description",
       "email": "merchant26maydemo@example.com",
       "phone_calling_code": "62",
       "phone_number": "81234567890",
       "website_readiness": "DONT_HAVE",
       "mobile_app_readiness": "DONT_HAVE",
       "brands": [
           {
               "name": "Brand Merchant 26 May",
               "description": "Merchant 26 May Brand Description",
               "category": "NON_RETAIL",
               "transaction_frequency": "UMI",
               "transaction_quantity": "UP_TO_100",
               "social_media": [
                   {
                       "accounts": [
                           "https://www.instagram.com/merchant"
                       ],
                       "code": "INSTAGRAM"
                   },
                   {
                       "accounts": [
                           "https://www.facebook.com/merchant"
                       ],
                       "code": "FACEBOOK"
                   }
               ],
               "photo_proofs": [
                   {
                       "id": "DCM-0131-1234567890123"
                   }
               ]
           }
       ],
       "addresses": [
           {
               "area": "17133 - Kali Baru - Medan Satria - Bekasi - Jawa Barat",
               "country": "ID",
               "name": "Jalan Selatan Barat no 123, Bekasi Utara",
               "primary": true
           }
       ],
       "banks": [
           {
               "account_name": "John Doe",
               "account_number": "98765432",
               "bank_id": "4",
               "bank_name": "BANK BCA",
               "country": "ID",
               "currency": "IDR",
               "swift_code": "014"
           }
       ],
       "contacts": [
           {
               "documents": [
                   {
                       "code": "KTP",
                       "category": "DOCUMENT",
                       "id": "DCM-0132-1234567890123",
                       "forms": [
                           {
                               "code": "NO_KTP",
                               "value": "1234567890123456"
                           }
                       ]
                   }
               ],
               "email": "john.doe@example.com",
               "name": "John Doe",
               "nationality": "ID",
               "phone_calling_code": "62",
               "phone_number": "81987654321",
               "position": "OWNER",
               "primary": true,
               "owner_liveness": {
                   "id": "CNT-0114-1234567890123"
               }
           }
       ]
   },
    "partner": {
       "invited_user": [
           "partner@example.com"
       ]
   }
}
ParameterTypeMandatoryDescription

business.type

string(8)

Mandatory

Possible Value : PERSONAL

business.legal_entity

string

Mandatory

PERSEORANGAN

business.name

string

Mandatory

For PERSONAL, business.name same as business.brands.name

business.email

string

Mandatory

Business Email

business.description

String(1023

Optional

For PERSONAL, business.description same as business.brands.description

business.calling_code

int(2)

Mandatory

Business calling code .e.g 62

business.phone_number

int(13)

Mandatory

Business phone number

business.brands.name

string(255)

Mandatory

For PERSONAL, business.brands.name same as business.name e.g. Merona Store

business.brands.category

string(10)

Mandatory

business.brands.description

string(1023)

Mandatory

For PERSONAL, business.brands.description same as business.description

business.brands.transaction_frequency

string(3)

Optional

business.brands.transaction_quantity

string(255)

Optional

business.addresses.area

string(255)

Mandatory

Business address area, e.g 17133 - Kali Baru - Medan Satria - Bekasi - Jawa Barat

business.addresses.country

String(2)

Mandatory

ID

business.addresses.name

String(255)

Mandatory

Business addresses name, e.g Jalan Gatot Subroto No 20

business.addresses.primary

boolean

Mandatory

Is the business address as primary ? Value : true/false

business.contacts.name

String(255)

Mandatory

Business contacts name

business.contacts.email

String(320)

Mandatory

Business contacts email

business.contacts.nationality

String(2)

Mandatory

Business contacts nationality, e.g ID

business.contacts.phone_calling_code

Integer(2)

Mandatory

62

business.contacts.phone_number

Integer(14)

Mandatory

Business phone number

business.contacts.position

String(255)

Mandatory

Default: OWNER

business.contacts.primary

boolean

Mandatory

Is the business contacts is primary contact ? Value : true/false

business.contacts.owner_liveness.id

String(255)

Mandatory

Filled with file.id from Upload File API

business.contacts.documents.code

String(255)

Mandatory

KTP

business.contacts.documents.category

String(255)

Mandatory

DOCUMENT

business.contacts.documents.id

String(22)

Mandatory

Generated from Upload File API

business.contacts.documents.forms.code

String(255)

Mandatory

NO_KTP

business.contacts.documents.forms.value

String(255)

Mandatory

Generated from Upload File API

business.banks.account_name

String(255)

Mandatory

The account name

business.banks.account_number

Integer(255)

Mandatory

The bank account number

business.banks.bank_id

String(3)

Mandatory

4 [Bank ID]

business.banks.bank_name

String(255)

Mandatory

BANK BCA [Bank Name]

business.banks.country

String(2)

Mandatory

ID

business.banks.currency

String(3)

Mandatory

Only IDR

business.banks.swift_code

String(11)

Mandatory

014 [Swift Code Bank]

business.bank_account

String(255)

Mandatory

Generated from Upload File API

Possible Values

business.brands.category

ValueDescription

RETAIL

Selling physical product

NON_RETAIL

Selling digital product or services

ParameterPossible Values

businessType

PERSONAL

businessLegalEntity

PERSEORANGAN

businessContactNationality

ID

business.brands.transaction_frequency

Transaction FrequencyTotal Amount of Monthly Transaction (Rupiah)

UKE

<200 Mio

UME

200 Mio - 4 Bio

UBE

4 Bio

business.brands.transaction_quantity

Transaction QuantityTotal Number of Monthly Transaction

UP_TO_100

<100

100_10K

100 - 10.000

MORE_THAN_10K

>10.000

Response

{
   "business": {
       "type": "PERSONAL",
       "name": "Business Partner CRM Check",
       "description": "Description for personal partner CRM DOKU",
       "email": "example_partnernew@doku.com",
       "phone_calling_code": "62",
       "phone_number": "81234567890",
       "id": "BSN-0105-1234567890123",
       "status": "UPDATING",
       "utm_source": "example_source",
       "utm_medium": "example_medium",
       "utm_campaign": "example_campaign",
       "partner": "BRN-0201-1234567890123",
       "website_readiness": "HAVE",
       "mobile_app_readiness": "UNDER_DEVELOPMENT",
       "legal_entity": "PERSEORANGAN",
       "created_by": "BRN-0201-1234567890123",
       "is_partner": true,
       "brands": [
           {
               "id": "BRN-0110-1234567890123",
               "name": "Brand Personal Partner Test",
               "status": "UPDATING",
               "category": "NON_RETAIL",
               "shared_key": "SK-ExampleSharedKey",
               "minimum_transaction": 0,
               "maximum_transaction": 100,
               "transaction_frequency": "UMI",
               "transaction_quantity": "UP_TO_100",
               "ticket_size": "UP_TO_50K",
               "social_media": [
                   {
                       "id": "SCM-0109-1234567890123",
                       "account": "https://www.instagram.com/exampleid",
                       "status": "UPDATING",
                       "name": "INSTAGRAM"
                   },
                   {
                       "id": "SCM-0110-1234567890123",
                       "account": "https://www.facebook.com/exampleid",
                       "status": "UPDATING",
                       "name": "FACEBOOK"
                   }
               ],
               "photo_proofs": [
                   {
                       "id": "PHP-0128-1234567890123",
                       "category": "PHOTO_PROOF",
                       "link": "https://example.com/photo_proof.jpg",
                       "status": "UPDATING"
                   }
               ],
               "services": [
                   {
                       "id": "PRD-0168-1234567890123",
                       "code": "ONLINE_TO_OFFLINE_ALFA_AGGREGATOR",
                       "name": "Alfa Group (Aggregator)",
                       "status": "ACTIVE"
                   },
                   {
                       "id": "PRD-0169-1234567890123",
                       "code": "DOKU_WALLET",
                       "name": "DOKU Wallet",
                       "status": "ACTIVE"
                   },
                   {
                       "id": "PRD-0170-1234567890123",
                       "code": "PEER_TO_PEER_AKULAKU",
                       "name": "Akulaku",
                       "status": "ACTIVE"
                   },
                   {
                       "id": "PRD-0171-1234567890123",
                       "code": "VIRTUAL_ACCOUNT",
                       "name": "Virtual Account (Multiple Banks)",
                       "status": "ACTIVE"
                   },
                   {
                       "id": "PRD-0172-1234567890123",
                       "code": "VIRTUAL_ACCOUNT_PARTNER_AGGREGATOR",
                       "name": "VA Aggregator (Multiple Banks)",
                       "status": "ACTIVE"
                   },
                   {
                       "id": "PRD-0173-1234567890123",
                       "code": "CREDIT_CARD_AGGREGATOR",
                       "name": "Credit Card (Partner Aggregator)",
                       "status": "ACTIVE"
                   }
               ]
           }
       ],
       "contacts": [
           {
               "id": "CNT-0125-1234567890123",
               "name": "Contact Example Partner",
               "email": "business_contact+example@doku.com",
               "phone_calling_code": "62",
               "phone_number": "81987654321",
               "position": "OWNER",
               "nationality": "Indonesia",
               "primary": true,
               "documents": [
                   {
                       "id": "DCM-0140-1234567890123",
                       "category": "DOCUMENT",
                       "code": "KTP",
                       "forms": [
                           {
                               "code": "NO_KTP",
                               "value": "1234567890123456"
                           }
                       ],
                       "link": "https://example.com/ktp_document.jpg"
                   },
                   {
                       "id": "CNT-0125-1234567890123",
                       "category": "OWNER_LIVENESS",
                       "link": "https://example.com/owner_liveness.jpg"
                   }
               ]
           }
       ],
       "addresses": [
           {
               "name": "Jalan Example no 78, Bekasi Utara",
               "area": "17133 - Example Area - Example City - Jawa Barat",
               "country": "Indonesia",
               "primary": true
           }
       ],
       "banks": [
           {
               "account_name": "Example Test QA",
               "account_number": "98765432",
               "currency": "Indonesian Rupiah",
               "bank_name": "BANK BCA",
               "overseas": false,
               "swift_code": "014",
               "country": "Indonesia"
           }
       ]
   }
}
ParameterData TypePossible ValueDescription

business.id

String(22)

BSN-0102-1676676916608

Business ID Merchant

business.status

String(10)

UPDATING

Business Status description:

UPDATING: On Review

ACTIVE: Business Approved

business.partner

String(320)

BRN-0231-1675929715659

Your Partner ID

business.created_by

String(320)

BRN-0231-1675929715659

Your Partner ID

business.brands.id

String(22)

BRN-0102-1676676916608

Generate Brand ID for your merchant

business.brands.shared_key

String(255)

SK-mNWhry06VRwzIHnxKnQ9

Shared Key to generate signature on bhelaf of merchant

business.brands.social_media.id

String(22)

SCM-0103-1676676916616

Social Media Entity Id

business.brands.social_media.status

String(22)

UPDATING,REJECTED,ACTIVE

Social Media Status:

UPDATING: On Review

ACTIVE: Social Media Approved

REJECTED: Social media Rejected

business.brands.photo_proofs

String(22)

PHP-0102-1676676916620

business.brands.photo_proofs.status

String(22)

business.brands.services.id

String(22)

business.brands.services.code

String(255)

business.brands.services.name

String(255)

business.brands.services.status

String(10)

business.brands.contacts.id

String(255)

business.brands.contacts.document

String(255)

Last updated