API Account Opening

Buat API

Version Control

Versi API

Tanggal

Deskripsi

v1.0

27 Maret 2024

Versi dasar

v1.1

30 April 2024

Pembaruan ini menggabungkan tipe data yang komprehensif, panjang, dan atribut wajib.

Memperbarui Daftar Kode Kesalahan/Tanggapan. Menambahkan urutan kartu virtual dan detail titik akhir.
v1.2 20 June 2024 Dokumen Spesifikasi API.

A. Product Overview

Gambaran Produk

API Pembukaan Rekening menghadirkan solusi yang kuat, memberdayakan mitra/pihak ketiga untuk menawarkan pengalaman online yang tanpa hambatan dan aman bagi calon nasabah yang ingin membuka rekening. API yang transformatif ini menghilangkan kebutuhan untuk mengunjungi cabang secara fisik, merevolusi proses onboarding tradisional dan mengantarkan era baru kenyamanan dan efisiensi bagi mitra/pihak ketiga dan nasabah mereka.

Proses pembukaan rekening terdiri dari beberapa langkah berurutan sebagai berikut:

 

briva online

B. Sequence Diagram API Account Opening

Open Banking Diagram

C. Endpoint Lists

1. API Send Pre-request Data

Deskripsi Endpoint

API Kirim Data Pra-permohonan berfungsi sebagai titik masuk awal bagi calon pelanggan yang ingin membuka rekening melalui organisasi atau platform mitra Anda. API ini memungkinkan proses pra-aplikasi yang lancar dan efisien, sehingga pengguna dapat mengirimkan data dan dokumen awal secara elektronik.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/preRequestData

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan.

2020102900000000000001

consentId

String

M

 

 

 

identificationNo

String

M

16

Nomor Induk Kependudukan (NIK) pemohon dalam format 16 digit

 

name

String

M

 

Nama lengkap pemohon yang sah

Agung Harsono

bornDate

String

M

10

Tanggal lahir pemohon dalam format DD-MM-YYYY

17-08-1945

phoneNo

String

M

13

Nomor ponsel pemohon

081213456789

motherName

String

M

 

 

 

countryCode

String

M

4

 

 

email

String

M

 

Alamat email utama pemohon

agungharsono@gmail.com

referralCode

String

O

 

Kode yang digunakan untuk mengidentifikasi pengguna yang mereferensikan pemohon ini (jika ada)

 

requestRefnum

String

M

12

Nomor referensi unik yang diberikan untuk permintaan pembukaan rekening ini.

123456789012

timestamp

String

M

13

 

  

Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode respons

 

responseMessage

String

M

150

Deskripsi tanggapan

 

originalPartnerReferenceNo

String

 

 

 

 

originalReferenceNo

String

 

 

 

 

responseId

String

 

 

 

 

customerId

String

 

36

Pengenal unik untuk akun pelanggan yang baru dibuat

 

phoneNo

String

 

13

Nomor telepon terverifikasi yang terkait dengan pembuatan akun baru

 

method

String

 

 

Metode yang digunakan untuk verifikasi (mis. SMS, WA).

 

status

Numeric

 

 

 

 

expiredInSecond

Numeric

 

 

 

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "consentId": "",
  "identificationNo": "3674010909940005",
  "name": "Agung Harsono",
  "bornDate": "17-08-1945",
  "phoneNo": "08121345XXXX",
  "motherName": "Ibu",
  "countryCode": "Jakarta",
  "email": "agungharsono@gmail.com",
  "referralCode": "00123456",
  "requestRefnum": "123456789012",
  "timestamp": "1696996569871"
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successful",
  "originalReferenceNo": "2020102977770000000009",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "responseId": "d553f38e480844b683578d75844bac00",
  "additionalInfo": {
    "customerId": "11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea",
    "phoneNo": "08123456789",
    "method": "SMS",
    "status": 1,
    "expiredInSecond": 180
  }
}

Error Response :

{
  "responseCode": "4000600",
  "responseMessage": "Bad Request"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Message

Description

200

2000600

Sukses

Successful

Sukses

400

4000600

Gagal

Bad Request

General request failed error, including message parsing failed

400

4000601

Gagal

Invalid Field Format {fieldName}

Invalid format

400

4000602

Gagal

Invalid Mandatory Field {fieldName}

Missing or invalid format on mandatory field

401

4010600

Gagal

Unauthorized. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030605

Gagal

Do Not Honor

Status Akun atau Pengguna tidak normal

403

4030615

Gagal

Transaction Not Permitted. [Reason]

Transaksi Tidak Diizinkan

404

4040607

Gagal

Journey Not Found

JourneyID tidak dapat ditemukan dalam sistem

409

4090600

Gagal

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Gagal

General Error

Kesalahan Umum

500

5000601

Gagal

Internal Server Error

Kegagalan Server Internal yang Tidak Diketahui, Silakan coba lagi prosesnya

500

5000602

Gagal

External Server Error

Kegagalan sistem backend

504

5040600

Gagal

Timeout

Waktu habis dari penerbit

2. API Resend OTP

Deskripsi Endpoint

API Kirim Ulang OTP digunakan untuk mengirim ulang One-Time Password (OTP) ke nomor ponsel pemohon yang terdaftar sebagai bagian dari proses aplikasi pembukaan rekening. API ini bertujuan untuk memberikan kesempatan kepada pemohon untuk menyelesaikan proses verifikasi jika tidak menerima OTP dalam jangka waktu tertentu.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/resendOtp

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Parameter

Data Type

Mandatory

Length

Description

Example

timestamp

String

M

13

 

 

requestRefnum

String

M

12

 

 

partnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan

2020102900000000000001

method

String

M

3

 

 

customerId

String

M

36

ID aplikasi unik yang diberikan pada saat permintaan pembuatan akun awal. ID ini tidak menandakan akun yang aktif, gunakan nomor ini untuk menanyakan status aplikasi.

 

additionalInfo

Object

M

 

 

  

Response Structure

Field

Data type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode respons

 

responseMessage

String

M

150

Deskripsi respons

 

originalPartnerReferenceNo

String

C

64

Pengenal transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil

 

originalReferenceNo

String

O

64

Pengidentifikasi transaksi pada sistem konsumen layanan

 

additionalInfo

Object

M

 

 

 

customerId

String

O

36

Pengenal unik untuk akun pelanggan yang baru dibuat

 

phone

String

M

13

 

 

method

String

M

3

 

 

expiredInSecond

Numeric

M

 

Masa berlaku kode OTP dalam detik, ini menentukan durasi dalam detik di mana kode OTP akan berlaku sebelum kedaluwarsa.

 

status

Numeric

M

 

 

 

responseId

String

M

 

 

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
    "customerId": "11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea",
    "method": "SMS",
    "requestRefnum": "123456789012",
    "timestamp": "1696996569871"
  }
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successful",
  "originalReferenceNo": "20201029777",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
    "customerId": "123xyz789",
    "phone": "08123456789",
    "method": "SMS",
    "expiredInSecond": 180,
    "status": 1,
    "responseId": "d553f38e480844b683578d75844bac00"
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Sukses

Successful

Berhasil

400

4000600

Gagal

Bad Request

Kesalahan permintaan umum gagal, termasuk penguraian pesan gagal

400

4000601

Gagal

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Gagal

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Gagal

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030615

Gagal

Transaction Not Permitted. [Reason]

Transaksi Tidak Diizinkan

404

4040607

Gagal

Journey Not Found

ID perjalanan tidak dapat ditemukan dalam sistem

409

4090600

Gagal

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Gagal

General Error

Kesalahan umum

504

5040600

Gagal

Timeout

Waktu habis dari penerbit

3. API Verify OTP

Deskripsi Endpoint

API Verify OTP digunakan untuk memverifikasi kode One-Time Password (OTP) yang dikirimkan kepada pemohon untuk memverifikasi nomor ponsel mereka dan menyelesaikan proses pembukaan rekening. API ini bertujuan untuk memastikan bahwa pemohon yang memasukkan OTP adalah pengguna yang sah dan mengurangi risiko penipuan dan akses yang tidak sah selama proses pembukaan rekening.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/verifyOTP

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

 

 

otp

String

M

6

Kata Sandi Sekali Pakai (OTP) yang diterima pengguna melalui SMS/Whatsapp

 

type

String

M

 

arah penggunaan dari verify otp:
- OA
- DIRDEB

 

additionalInfo

String

M

 

 

 

customerId

String

M

36

 

 

requestRefnum

String

M

12

 

 

timestamp

String

M

13

 

  

Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

 

 

 

responseMessage

String

M

 

 

 

originalReferenceNo

String

M

 

Identifikasi transaksi asli pada sistem penyedia layanan. harus diisi setelah transaksi berhasil

 

originalPartnerReferenceNo

String

M

 

Identifikasi transaksi asli pada sistem layanan konsumen

 

additionalInfo

Object

 

 

 

 

customerId

String

M

 

 

 

email

String

M

 

 

 

expiredInSecond

Numeric

M

 

Waktu yang tersisa dalam hitungan detik agar OTP valid

 

status

Numeric

M

 

 

 

responseId

String

M

 

 

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "merchantId": "",
  "otp": "140450",
  "type": "OA",
  "additionalInfo": {
    "customerId": "123xyz789",
    "requestRefnum": "123456789012",
    "timestamp": "1696996569871"
  }
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successful",
  "originalReferenceNo": "20201029777",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
    "customerId": "123xyz789",
    "email": "andariaaa@gmail.com",
    "status": 2,
    "expiredInSecond": 300,
    "responseId": "d553f38e480844b683578d75844bac00"
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Berhasil

400

4000600

Failed

Bad Request

Kesalahan permintaan umum gagal, termasuk penguraian pesan gagal

400

4000601

Failed

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Failed

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030612

Failed

OTP Lifetime Expired

OTP telah kedaluwarsa

403

4030615

Failed

Transaction Not Permitted. [Reason]

Transaski yang tidak diinginkan

404

4040607

Failed

Journey Not Found

ID perjalanan tidak dapat ditemukan dalam sistem

404

4040615

Failed

Invalid OTP

OTP salah

409

4090600

Failed

Conflict

Kesalahan umum

500

5000600

Failed

General Error

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

504

5040600

Failed

Timeout

Waktu habis dari penerbit

4. API Resend Email

Deskripsi Endpoint

API Kirim Ulang Email menyediakan alat yang berharga untuk memfasilitasi proses penerimaan pelanggan yang lancar dan efisien dengan menawarkan kesempatan kedua kepada calon klien untuk menyelesaikan verifikasi email. Fungsionalitas ini mengatasi kasus-kasus di mana email verifikasi awal mungkin belum diterima atau kedaluwarsa, yang berpotensi menghambat kemajuan mereka dalam pembuatan akun. Harap diperhatikan bahwa tautan verifikasi email hanya berlaku selama 10 menit ke depan. Setelah itu, pelanggan perlu meminta tautan baru untuk melanjutkan proses pembukaan akun.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/resendEmail

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan

2020102900000000000001

additionalInfo

Object

O

 

 

 

customerId

String

M

36

Pengenal unik untuk akun pelanggan yang baru dibuat

123xyz789

email

String

M

 

Alamat email yang akan menerima tautan verifikasi

 

requestRefnum

String

M

12

Nomor referensi unik yang diberikan untuk permintaan pembukaan rekening ini

123456789012

timestamp

String

M

13

 

 

Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Response code

 

responseMessage

String

M

150

Response description

 

originalReferenceNo

String

M

 

Identifikasi transaksi asli pada sistem penyedia layanan. harus diisi setelah transaksi berhasil

 

originalPartnerReferenceNo

String

M

 

Identifikasi transaksi asli pada sistem layanan konsumen

 

additionalInfo

Object

 

 

 

 

customerId

String

M

36

ID aplikasi unik yang diberikan pada saat permintaan pembuatan akun awal (pra-permintaan)

123xyz789

phone

String

M

13

Alamat email penerima untuk menerima tautan verifikasi

 

method

String

M

3

 

 

status

Numeric

M

 

 

 

expiredInSecond

Numeric

M

 

Waktu kedaluwarsa tautan verifikasi (detik)

 

responseId

String

M

 

 

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
    "customerId": "123xyx789",
    "email": "agungharsono2@gmail.com",
    "requestRefnum": "123456789012",
    "timestamp": "1696996569871"
  }
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successful",
  "originalReferenceNo": "20201029777",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
    "customerId": "123xyz789",
    "phone": "0813xxxxx",
    "method": "WA",
    "status": 2,
    "expiredInSecond": 180,
    "responseId": "6331c5ade50b4a68b41c995f6644b2a1"
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Berhasil

400

4000600

Failed

Bad Request

Kesalahan permintaan umum gagal, termasuk penguraian pesan gagal

400

4000601

Failed

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Failed

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030615

Failed

Transaction Not Permitted. [Reason]

Transaksi Tidak Diizinkan

404

4040607

Failed

Journey Not Found

ID perjalanan tidak dapat ditemukan dalam sistem

409

4090600

Failed

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Failed

General Error

Kesalahan Umum

504

5040600

Failed

Timeout

Batas waktu dari penerbit

5. API Send KYC

Deskripsi Endpoint

API Send KYC memfasilitasi pengiriman data Know Your Customer (KYC) yang aman, seperti foto KTP dan video kehidupan, ke Bank. Data ini sangat penting untuk memverifikasi identitas nasabah dan mematuhi peraturan Bank Indonesia selama proses pembukaan rekening.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/sendKyc

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

 

 

customerId

String

M

36

Pengenal unik untuk akun pelanggan yang baru dibuat

123xyz789

requestRefnum

String

M

12

 

 

timestamp

String

M

13

 

  

Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode respons

 

responseMessage

String

M

150

Deskripsi tanggapan

 

originalPartnerReferenceNo

String

 

 

 

 

originalReferenceNo

 

 

 

 

 

additionalInfo

Object

 

 

 

 

customerId

String

 

36

 

 

responseId

String

 

 

 

 

status

Numeric

 

 

 

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "customerId": "123xyx789",
  "requestRefnum": "123456789012",
  "timestamp": "1696996569871"
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successful",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "originalReferenceNo": "123456789012",
  "additionalInfo": {
    "customerId": "123xyz789",
    "responseId": "6331c5ade50b4a68b41c995f6644b2a1",
    "status": 4
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Berhasil

400

4000600

Failed

Bad Request

Kesalahan permintaan umum gagal, termasuk penguraian pesan gagal

400

4000601

Failed

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Failed

Unauthorized. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030615

Failed

Transaction Not Permitted. [Reason]

Transaksi Tidak Diizinkan

404

4040607

Failed

Journey Not Found

ID perjalanan tidak dapat ditemukan dalam sistem

409

4090600

Failed

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Failed

General Error

Kesalahan Umum

500

5000601

Failed

Internal Server Error

Kegagalan Server Internal yang Tidak Diketahui, Silakan coba lagi prosesnya

504

5040600

Failed

Timeout

Batas waktu dari penerbit

6. API Account Creation

Deskripsi Endpoint

API Account Creation digunakan untuk mengirimkan data pemohon dan meminta proses pembukaan rekening secara online.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/accountCreation

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Parameter

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan

2020102900000000000001

customerId

String

M

36

ID aplikasi unik yang diberikan pada saat permintaan pembuatan akun awal (pra-permintaan). ID ini tidak menandakan akun yang aktif, gunakan nomor ini untuk menanyakan status aplikasi.

11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea

additionalInfo

Object

 

 

 

 

requestRefnum

String

 

12

 

 

timestamp

String

 

13

 

 

selfData

Object

 

 

Informasi pribadi pemohon

 

bornPlace

String

 

 

Tempat lahir

Jakarta

gender

String

 

1

Jenis kelamin pemohon

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

M

religion

String

 

3

Agama pemohon

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

ISL

education

String

 

2

Tingkat pendidikan tertinggi yang dicapai pemohon

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

S1

maritalStatus

String

 

1

Status perkawinan pemohon

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

K

addressData

Object

 

 

Informasi alamat tempat tinggal pemohon

 

postcode

String

 

5

Lima digit kode pos tempat tinggal

12550

postcodeDetail

String

 

 

Rincian kode pos tambahan

Ragunan, Pasar Minggu, Jakarta Selatan

rt

String

 

3

 

007

rw

String

 

3

 

005

addressDetail

String

 

 

Detail alamat lengkap

Jl. Harsono 26

domPostcode

String

 

5

Lima digit kode pos yang terkait dengan domisili

 

domPostcodeDetail

String

 

 

Rincian kode pos tambahan dari tempat tinggal pemohon saat ini

 

domRt

String

 

3

 

 

domRw

String

 

3

 

 

domAddressDetail

String

 

 

Rincian alamat tempat tinggal pemohon saat ini

 

jobData

Object

 

 

Informasi tentang pekerjaan pelamar

 

officeName

String

 

 

Nama pemberi kerja pemohon

BRI

jobGroup

String

 

4

Sektor industri dari pekerjaan pelamar

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

BUMN

jobRole

String

 

2

Jabatan atau posisi pelamar

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

64

jobPostcode

String

 

5

Lima digit kode pos tempat kerja

 

jobPostcodeDetail

String

 

 

Rincian kode pos tambahan

 

jobRt

String

 

3

 

 

jobRw

String

 

3

 

 

jobAddressDetail

String

 

 

Rincian alamat lengkap tempat kerja

 

financialData

Object

 

 

Informasi keuangan pemohon

 

incomeSource

String

 

2

Sumber pendapatan utama

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

11

incomeMonthly

String

 

2

Rata-rata pendapatan bulanan

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

G1

dailyTransaction

String

 

2

Perkiraan nilai transaksi harian rata-rata

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

N1

purpose

String

 

2

Tujuan pembukaan rekening

catatan: untuk daftar data yang lebih rinci, silakan lihat Daftar Data

T1

Response Structure

Parameter

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode respons

 

responseMessage

String

M

150

Deskripsi tanggapan

 

originalPartnerReferenceNo

String

 

 

Pengidentifikasi transaksi pada sistem konsumen layanan

 

originalReferenceNo

String

 

 

Pengenal transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil

 

additionalInfo

Object

 

 

Informasi tambahan

 

customerId

String

 

36

 

 

responseId

String

 

 

 

 

status

Numeric

 

 

 

 

urlUserBrimo

String

 

 

url tampilan web buat pengguna brimo

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "3287423894732",
  "customerId": "11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea",
  "additionalInfo": {
    "requestRefnum": "123456789012",
    "timestamp": "1696996569871",
    "selfData": {
      "bornPlace": "Jakarta",
      "gender": "M",
      "religion": "ISL",
      "education": "S2",
      "maritalStatus": "K"
    },
    "addressData": {
      "postcode": "12550",
      "postcodeDetail": "Ragunan, Pasar Minggu, Jakarta Selatan",
      "rt": "007",
      "rw": "005",
      "addressDetail": "Jl. Harsono 26",
      "domPostcode": "12550",
      "domPostcodeDetail": "Ragunan, Pasar Minggu, Jakarta Selatan",
      "domRt": "007",
      "domRw": "005",
      "domAddressDetail": "Jl. Harsono 26"
    },
    "jobData": {
      "officeName": "BRI",
      "jobGroup": "BUMN",
      "jobRole": "64",
      "jobPostcode": "12551",
      "jobPostcodeDetail": "Pasar Rebo, Pasar Malem, Jakarta Pusat",
      "jobRt": "001",
      "jobRw": "002",
      "jobAddressDetail": "Jl. Sudirman Said"
    },
    "financialData": {
      "incomeSource": "11",
      "incomeMonthly": "G1",
      "dailyTransaction": "N1",
      "purpose": "T1"
    }
  }
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successful",
  "originalReferenceNo": "20201029777",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "additionalInfo": {
  "customerId": "11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea",
  "status": 4,
  "responseId": "88330f385a8c4925864b0c1aad6a2842",
  "urlUserBrimo": "https://ms-briapi-web-view-oa.dev.bbri.io/?onboardingId=11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea"
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Sukses

Successful

Berhasil

400

4000600

Gagal

Bad Request

Kesalahan permintaan umum gagal, termasuk penguraian pesan gagal

400

4000601

Gagal

Invalid Field Format {fieldName}

 Format tidak valid

400

4000602

Gagal

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Gagal

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030615

Gagal

Transaction Not Permitted. [Reason]

Transaksi Tidak Diizinkan

404

4040607

Gagal

Journey Not Found

ID perjalanan tidak dapat ditemukan dalam sistem

409

4090600

Gagal

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Gagal

General Error

Kesalahan Umum

504

5040600

Gagal

Timeout

Batas waktu dari penerbit

Data List

Pengkodean Value pada Request

1. Personal Information

1.1 Gender

Code

Value

M

Laki-Laki
F Perempuan

1.2 Religion

Code

Value

ISL

Islam
KAT Katolik
KRI Protestan
BUD Buddha
HIN Hindu
ZZZ Konghucu
ZZZ Lainnya

1.3 Education

Code

Value

SD

SD/Sederajat
SM SLTP/SMP/Sederajat
SU SLTA/SMU/SMK/Sederajat
S1 D4/S1
S2 S2
S3 S3
ZZ

Lainnya

1.4 Martial Status

Code

Value

B

Belum Kawin
K Kawin
D Duda
J Janda

2. Employment Data

2.1. Job Group

Code

Value

PENG

Belum Bekerja/Pencari Kerja
BUMN Pegawai BUMN
ADMI Administrasi Umum / Supervisor
AKUN Akunting / Keuangan
DAGA Pedagang
DKTR Dokter
EXEC Executive / Managerial
GURU Pengajar/Guru/Dosen PNS
GUSW Pengajar/Guru/Dosen Swasta
IBRT Ibu Rumah Tangga
KOMP Ahli Komputer/Programmer
KONS Konsultan
MAHA Mahasiswa
MILD Militer (TNI - AD)
MILL Militer (TNI - AL)
MILP Militer (POLRI)
MILU Militer (TNI - AU)
NOTA Notaris
PELA Pelajar
PEMI Pemilik Perusahaan
PENS Pensiunan
PGCR Pengacara
PNSI Pegawai Negeri Sipil
PROD Produksi/Operasi/ Manufaktur
PROF Professional
RISE Riset & Pengembangan
SALE Sales/Marketing/Promosi
SENI Seniman
SERV Service/Customer Support/Layanan
SWAS Pegawai Swasta
TECH Technical / Engineering-lainnya
WIRA Wiraswasta

2.2 Job Role

Code

Value

01

 Pemilik, Direktur Utama/Presiden Dir.
02 Pemilik, Direktur
03 Pemilik, Komisaris Utama/Presiden Kom.
04 Pemilik, Komisaris
06 Pemilik, Kuasa Direksi
07 Pemilik, Bukan Pengurus
08 Pemilik, Grup
09 Pemilik, Masyarakat
10 Pemilik, Ketua Umum
11 Pemilik, Ketua
12 Pemilik, Sekretaris
13 Pemilik, Bendahara
14 Ketua MPR
15 Wakil Ketua MPR
16 Anggota MPR
17 Ketua DPR
18 Wakil Ketua DPR
19 Anggota DPR
20 Presiden
21 Wakil Presiden
22 Menteri
23 Pejabat setingkat menteri
24 Eksekutif dan Ketua Parpol
25 Gubernur
26 Wakil Gubernur
27 Walikota
28 Wakil Walikota
29 Bupati
30 Wakil Bupati
31 Camat
32 Lurah
33 Hakim
34 Direksi BUMN atau BUMD
35 Komisaris BUMN atau BUMD
36 Pimpinan Bank Indonesia
37 Pimpinan BPPN
38 Kepala Divisi BUMN atau BUMD
39 Wakil Kepala Divisi BUMN atau BUMD
40 Rektor, Pembantu Rektor, Dekan
41 Jaksa
42 Kapolri, Wakapolri, Kapolda, Wakapolda
43 Panglima TNI, KSAD, KSAU, KSAL
44 Penyidik
45 Pejabat yang mengeluarkan perijina
46 Pejabat pembuat regulasi
47 Panitera Pengadilan
48 Pemimpin Proyek APBN atau APBD
49 Bendahara Proyek APBN atau APBD
50 Kepala Kantor di Departemen Keuangan
51 Pengurus, Direktur Utama/Presiden Dir
52 Pengurus, Direktur
53 Pengurus, Komisaris Utama/Presiden Kom
54 Pengurus, Komisaris
55 Pengurus, Kuasa Direksi
56 Pengurus, Grup
57 Pengurus, Ketua Umum
58 Pengurus, Ketua
59 Pengurus, Sekretaris
60 Pengurus, Bendahara
61 Pengurus, Lainnya
62 Pengawas Bea dan Cukai
63 Auditor
64 Staf
65 Petugas Administrasi
67 Petugas Kebersihan
68 Petugas Keamanan
69 Juru Masak
70 Ibu Rumah Tangga
71

Tidak Bekerja

3. Financial Data

3.1. Income Source

Code

Value

11

Gaji
12 Hasil Usaha
99 Lainnya

3.2. Monthly Income

Code

Value

G1

 1 - 5 Juta
G2 5 - 10 juta
G3 10 - 50 juta
G4 50 - 100 juta
G4 Di atas 100 juta

3.3. Daily Transaction

Code

Value

N1

 0 - 10 Juta
N2 10 Juta - 50 Juta
N3 50 Juta - 100 Juta
N4 100 Juta - 1 Milyar
N5 Lebih dari 1 Milyar

3.4. Account Opening Purpose

Code

Value

T1

 Tabungan
T2 Transaksi
T3 Pribadi
ZZ Lainnya

7. API Check Progress

Deskripsi Endpoint

API Check Progress digunakan untuk mendapatkan informasi status terbaru dari permohonan pembukaan rekening yang diajukan oleh mitra. API ini diharapkan dapat memberikan kontrol dan visibilitas kepada mitra/pihak ketiga terhadap proses aplikasi, sehingga memudahkan mitra untuk memberikan informasi yang lebih akurat kepada penggunanya.

General Information

HTTP Method

POST

Path

 /v1.0/openingAccount/checkProgress

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Field

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan.

2020102900000000000001

customerId

String

M

36

ID aplikasi unik yang diberikan pada saat permintaan pembuatan akun awal (pra-permintaan). ID ini tidak menandakan akun yang aktif, gunakan nomor ini untuk menanyakan status aplikasi.

11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea

requestRefnum

String

M

12

Nomor referensi unik yang diberikan untuk permintaan pembukaan rekening ini.

123456789012

timestamp

String

M

13

 

  

Response Structure

Field

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode Respons

 

responseMessage

String

M

150

Deskripsi Tanggapan

 

originalPartnerReferenceNo

String

M

64

 

 

originalReferenceNo

String

M

 

 

 

additionalInfo

Object

 

 

Informasi Tambahan

 

customerId

String

M

 

ID aplikasi unik yang diberikan pada saat permintaan pembuatan akun awal (pra-permintaan). ID ini tidak menandakan akun yang aktif, gunakan nomor ini untuk menanyakan status aplikasi.

11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea

phone

String

C

 

 

 

method

String

C

 

 

 

email

String

C

 

 

 

expiredInSecond

String

C

 

 

 

accountNumber

String

C

 

 

 

responseId

String

M

 

 

 

status

Numeric

M

 

Informasi status terbaru dari aplikasi pembukaan rekening

Code

Description

0

Not Started Yet, Submit Data

1

Done Submit, Verify Phone

2

Phone Verified, Verify Email

3

Email Verified, Submit Document

4

Document OK, KYC Progress

5

KYC Success, Submit Additional Data

6

Additional Data OK, Setup Username

7

Username OK, Setup PIN

8

PIN OK, Verify OTP Privy

9

OTP Privy OK, Retry Create Account

10

 Create Account OK, Retry Generate BRImo

11

Success

 

  

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "requestRefnum": "123456789012",
  "timestamp": "1696996569871"
  "customerId": "11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea"
}

Normal Response :

{
  "responseCode":"2000600",
  "responseMessage":"Successful",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "originalReferenceNo": "123456789012",
  "additionalInfo":{
  "customerId": "11ab41e6-e2e4-409c-88fc-50cea8fa2a6cea",
  "phone": "08123456789",
  "method": "WA",
  "expiredInSecond": 180,
  "responseId":"6331c5ade50b4a68b41c995f6644b2a1",
  "status": 1
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Sukses

400

4000601

Failed

Invalid Field Format {fieldName}

Kesalahan permintaan umum gagal, termasuk penguraian pesan gagal

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format tidak valid

401

4010600

Failed

Unauthoried. [Reason]

Format yang hilang atau tidak valid pada bidang wajib

409

4090600

Failed

Conflict

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

500

5000600

Failed

General Error

Kesalahan Umum

504

5040600

Failed

Timeout

Batas waktu dari penerbit

8. API Consent

Deskripsi Endpoint

Persetujuan API digunakan untuk menghasilkan persetujuan sebelum membuka akun.

General Information

HTTP Method

POST

Path

/v1.0/openingAccount/consent

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

 Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Parameter

Data Type

Mandatory

Length

Description

Example

partnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan.

2020102900000000000001

 

onBoardingPartner

String

M

16

Mitra orientasi dari ...

DANA

countryCode

String

M

2

Kode negara pemohon

ID

permissions

Array[String]

M

-

Menentukan izin akses data. Daftar ini merinci kategori data yang disetujui pengguna dan mengizinkan bank untuk dibagikan.

· ReadBalance

· ReadStatement

· ReadAccount

· OpenAccount

· BindingAccount

additionalInfo

Object

O

 

Informasi tambahan

{"deviceId": "12345679237", "channel": "mobilephone"}

Response Structure

Parameter

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode Respon

2000600

responseMessage

String

M

256

Deskripsi Tanggapan

Request has been processed successfully

originalReferenceNo

String

M

64

Pengenal transaksi pada sistem penyedia layanan. Harus diisi setelah transaksi berhasil.

2020102977770000000009

originalPartnerReferenceNo

String

M

64

Pengidentifikasi transaksi pada sistem konsumen layanan.

2020102900000000000001

consentId

String

M

32

Identifikasi unik sebagaimana ditetapkan untuk mengidentifikasi sumber daya persetujuan akses akun.

bri-consent-88379

creationDateTime

String

M

32

Tanggal dan waktu saat sumber daya dibuat. Format: ISO 8601.

2023-12-30T09:11:47.169Z

status

String

M

32

Menentukan status sumber daya persetujuan dalam bentuk kode.

awaiting_authorization

statusUpdateTime

String

M

32

Tanggal dan waktu saat status sumber daya diperbarui. Format: ISO 8601.

2023-12-30T09:11:47.169Z

permission

Array[String]

M

-

Menentukan izin akses data. Daftar ini merinci kategori data yang disetujui pengguna dan mengizinkan bank untuk dibagikan.

· ReadBalance

· ReadStatement

· ReadAccount

· OpenAccount

· BindingAccount

link

String

M

2048

Tautan ke dokumen persetujuan

https://api.bri.co.id/open-banking/bri-consent-1

additionalInfo

Object

O

 

Informasi tambahan

{"deviceId": "12345679237", "channel": "mobilephone"}

Request & Response Payload Sample

Request

{
  "partnerReferenceNo": "2020102900000000000001",
  "onBoardingPartner": "Kredivo",
  "countryCode": "ID",
  "permissions": [
    "ReadBalance",
    "ReadBalanceExact",
    "ReadStatement",
    "ReadStatementExact",
    "ReadAverageBalance",
    "ReadAverageBalanceExact",
    "ReadCreditScore",
    "ReadAccount"
  ],
  "additionalInfo": {
    "deviceId": "123456789237",
    "channel": "mobilephone"
  }
}

Normal Response :

{
  "responseCode": "2000600",
  "responseMessage": "Successfully",
  "originalReferenceNo": "2020102977770000000009",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "consentId": "bri-consent-88379",
  "creationDateTime": "2017-05-02T00:00:00+00:00",
  "status": "AwaitingAuthorization",
  "statusUpdateDateTime": "2017-05-02T00:00:00+00:00",
  "permissions": [
    "ReadBalances",
    "ReadStatements"
  ],
  "additionalInfo": {
    "deviceId": "12345679237",
    "channel": "mobilephone"
  }
}

Error Response :

{
  "responseCode": "5000600",
  "responseMessage": "General Error"
}

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Sukses

400

4000601

Failed

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Failed

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

403

4030615

Failed

Transaction Not Permitted. [Reason]

Transaksi Tidak Diizinkan

409

4090600

Failed

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Failed

General Error

Kesalahan Umum

504

5040600

Failed

Timeout

Batas waktu dari masalah ini

9. API Generate Virtual Card

Deskripsi Endpoint

API Generate Virtual Card berfungsi untuk menghasilkan kartu virtual bagi nasabah yang sebelumnya telah membuka rekening melalui “Layanan Pembukaan Rekening.”

General Information

HTTP Method

POST

Path

 /snap/v1.0/vcard/gen-virtual-card

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Parameter

Data Type

Mandatory

Length

Description

Example

accountNo

String

C

16

Bank account number. must be filled if bankCardToken is Null and Authorization-Customer is Null

  

Response Structure

Parameter

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode Respons

 

responseMessage

String

M

150

Deskripsi Tanggapan

 

queueId

String

M

64

 

  

Request & Response Payload Sample

Request

    {
      "accountNo": "0206xxxxxxxxxxx"
    }

Normal Response :

    {
      "responseCode": "2000600",
      "responseMessage": "Successful",
      "queueId": "210922T000000316590"
    }

Error Response :

    {
      "responseCode": "5000600",
      "responseMessage": "General Error"
    }

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Sukses

400

4000601

Failed

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Failed

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

409

4090600

Failed

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Failed

General Error

Kesalahan umum

504

5040600

Failed

Timeout

Batas waktu dari masalah ini

10. API Inquiry Virtual Card

Deskripsi Endpoint

API Generate Virtual Card berfungsi untuk menghasilkan kartu virtual bagi nasabah yang sebelumnya telah membuka rekening melalui “Layanan Pembukaan Rekening.”

General Information

HTTP Method

POST

Path

 /snap/v1.0/vcard/gen-virtual-card

Tipe Format

JSON

Authentication

OAuth 2.0 with Access Token

Header Structure

Key

Value

Type

Mandatory

Length

Example
Authorization Authorization String M   Bearer {Token}
X-TIMESTAMP timestamp Datetime M   Format Timestamp ISO8601
X-SIGNATURE signature String M   HMAC_SHA512
Content-type application/json   M   application/json
X-PARTNER-ID   Alphanumeric M 36  
CHANNEL-ID   Alphanumeric M 5  
X-EXTERNAL-ID   Numeric M 36  

Request Structure

Parameter

Data Type

Mandatory

Length

Description

Example

accountNo

String

C

16

Bank account number. must be filled if bankCardToken is Null and Authorization-Customer is Null

  

Response Structure

Parameter

Data Type

Mandatory

Length

Description

Example

responseCode

String

M

7

Kode Respons

 

responseMessage

String

M

150

Deskripsi Tanggapan

 

queueId

String

M

64

 

  

Request & Response Payload Sample

Request

    {
      "accountNo": "0206xxxxxxxxxxx"
    }

Normal Response :

    {
      "responseCode": "2000600",
      "responseMessage": "Successful",
      "queueId": "210922T000000316590"
    }

Error Response :

    {
      "responseCode": "5000600",
      "responseMessage": "General Error"
    }

List of Error/Response Code

HTTP Status

Code

Status

Response Description

Description

200

2000600

Success

Successful

Sukses

400

4000601

Failed

Invalid Field Format {fieldName}

Format tidak valid

400

4000602

Failed

Invalid Mandatory Field {fieldName}

Format yang hilang atau tidak valid pada bidang wajib

401

4010600

Failed

Unauthoried. [Reason]

Kesalahan umum yang tidak sah (Tidak Ada Antarmuka Def, API Tidak Valid, OAuth Gagal, Verifikasi Rahasia Klien Gagal, API Akses Terlarang Klien, Klien Tidak Dikenal, Kunci Tidak Ditemukan)

409

4090600

Failed

Conflict

Tidak dapat menggunakan X-EXTERNAL-ID yang sama di hari yang sama

500

5000600

Failed

General Error

Kesalahan umum

504

5040600

Failed

Timeout

Batas waktu dari masalah ini

D. Minio for EKYC

A. Access

Untuk setiap partner akan diberikan username dan password untuk dapat akses ke bucket minio. Alamat minio env prod: minio.bri.co.id
Nama bucket : baas-oa-nama_thirdparty

Terkait kebutuhan testing untuk minio (env dev) akan dibantu oleh tim partnership BRI.

B. How to Store File

  1. Create folder sesuai dengan customerId
  2. Menaruh file KYC :

No.

Data

Format File

1

KTP

.png

2

Video pernyataan calon nasabah BRI

.mp4

3

Image liveness

.png
  1. Penamaan File :

No.

Data

Penamaan File

1

KTP

ktp.png

2

Video pernyataan calon nasabah BRI

video.mp4

3

Image liveness

image1.png , image2.png