API Reference

Create Receiver

post
https://sandbox-api.sentbiz.com/v2/receivers

Register the recipient information required for a remittance.

You can use the recipient's Unique ID, provided in the response, for your remittance application.

The mandatory status of request parameter items may vary depending on the recipient country (destination_country) and method type (method_type).

For information on required items according to the recipient country (destination_country) and method type (method_type), please refer to the Required Parameters page.

  • [Mapping Reference] This API field name: Required Parameters page Column name
    • destination_country = Country - ISO Code
    • method_type = Method Type

Items marked as 'Required' among the request parameter items are commonly mandatory regardless of the recipient country and method.

If any required item confirmed on the Required Parameters page is missing, recipient registration will not be possible, and an error response will be returned.

Please use the Get Receive Methods API to confirm the recipient country (destination_country), recipient currency (destination_currency), available method types (method_type), and recipient institution code (destination_institution_code).

  • [Mapping Reference] This API field name: Get Receive Methods API field name
    • destination_country = country
    • destination_currency = currency
    • method_type = method
    • destination_institution_code = institution_code

If you attempt to send information not confirmed by the Get Receive Methods API, recipient registration will not be possible, and an error response will be returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Receiver type

Allowed:
string
required
length ≤ 100

Receiver’s English first name (when type is INDIVIDUAL)

Alternatively, English company name (when type is COMPANY)

string
length ≤ 100

Receiver English middle name

string
required
length ≤ 100

Receiver English last name

string

Receiver’s date of birth

  • Format: YYYY-MM-DD
string
required
length ≤ 100

City of residence

string
required
length ≤ 100

State of residence

string
required
length ≤ 100

Region of residence

string
required
length ≤ 2

The current country of residence

  • Two-letter ISO 3166-1 ALPHA-2 code for the country. (ex. KR, US, CN, …)
string
required
length ≤ 2

Nationality

  • Two-letter ISO 3166-1 ALPHA-2 code for the country. (ex. KR, US, CN, …)
string
required
length ≤ 500

Address line 1

  • The first line of the address, such as street name and number
string
length ≤ 500

Address line 2

  • The second line of the address, such as apartment or suite number
string
length ≤ 500

Address line 3

  • The third line of the address, such as additional information or landmarks
string
required
length ≤ 10
string
required
length ≤ 2

Mobile phone country code

  • Two-letter ISO 3166-1 ALPHA-2 code for the country. (ex. KR, US, CN, …)
string
required
length ≤ 8

Country Number (ex. 82, 1, 86, …)

string
required
length ≤ 100

Phone number

string
length ≤ 200

Email

string
enum

Identification type

  • KR_REG: Korean Resident Registration Card
  • KR_AL_REG: Korean Alien Registration Card
  • PASSPORT: Passport
  • KR_DRIVER: Korean driver's license
  • KR_BANK: Bank of Korea
  • KYC: Korea KYC
  • KR_BIZ_REG: Korean Business Registration Number
  • NATIVE_REG: Foreign identification document
  • ID_DRIVER: Indonesian driver's license
  • SG_NRIC: Singapore National Registration Identity Card (NRIC)
  • SG_FIN: Singapore Foreign Identification Number (FIN)
  • ID_KTP: Indonesian National Identity Card (KTP)
  • KITAS: Indonesian Temporary Stay Permit Card (KITAS)
  • US_DMV_DRIVER: United States Driver's License issued by the Department of Motor Vehicles (DMV)
  • US_DMV_ID: United States identification card issued by the Department of Motor Vehicles (DMV)
string
length ≤ 50

Identification number

string
length ≤ 50

Issuing authority

string

Date of issue

  • format: yyyy-MM-dd
string

Expiration date

  • format: yyyy-MM-dd
string
required
length ≤ 50

Client management number

string
enum
required

Pay-out Purpose Code

Allowed:
string
required
length ≤ 2

The country code receiving the money\n" +

  • Two-letter ISO 3166-1 ALPHA-2 code for the country. (ex. KR, US, CN, …)
string
required
length ≤ 3

The currency code of the destination currency bucket

  • Three-letter ISO 4217 code. (ex. KRW, USD, …)
string
enum
required

Receiving method type

Allowed:
string
length ≤ 50

Payment method number

string
required
length ≤ 50

Receiving agency code

string
enum

Account type

  • SAVING: Savings account
  • CURRENT: Checking account
  • CHECKING: Regular deposit account
  • INDIVIDUAL: Personal account
  • COMPANY: Corporate account
Allowed:
string
length ≤ 9

Bank branch code

string
length ≤ 100

Bank branch name

string
length ≤ 34

IBAN

string
length ≤ 11

SWIFT

string
length ≤ 11

Corresponding Bank SWIFT

string
length ≤ 6

BSB code

string
length ≤ 11

IFSC code

string
length ≤ 9

Routing number

string
length ≤ 6

Sort code

string
length ≤ 5

Transit code

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?