Create Account
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/accounts \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--data '
{
"entity_type": "INDIVIDUAL",
"name": "John Doe",
"contact_details": {
"email": "example@company.com",
"phone": "+6588880000"
},
"person_details": {
"first_name_english": "John",
"last_name_english": "Doe",
"nationality": "US",
"date_of_birth": "1990-01-01",
"banking_currencies": [
"USD"
],
"banking_countries": [
"US"
],
"monthly_estimated_revenue": {
"amount": "TM001",
"currency": "SGD"
},
"account_purpose": [],
"identification": {
"type": "PASSPORT",
"id_number": "A12345678",
"documents": {
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
},
"remark": "Valid until 2030",
"citizenship_status": "non_resident"
},
"first_name": "三",
"last_name": "张",
"local_name": "张三",
"tax_number": "123-45-6789",
"other_purpose": "<string>"
},
"residential_address": {
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
},
"documents": [
{
"type": "PROOF_OF_ADDRESS",
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
],
"tos_acceptance": {
"ip": "0.0.0.0",
"date": "2024-03-22T16:08:02+08:00",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
}
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/accounts"
payload = {
"entity_type": "INDIVIDUAL",
"name": "John Doe",
"contact_details": {
"email": "example@company.com",
"phone": "+6588880000"
},
"person_details": {
"first_name_english": "John",
"last_name_english": "Doe",
"nationality": "US",
"date_of_birth": "1990-01-01",
"banking_currencies": ["USD"],
"banking_countries": ["US"],
"monthly_estimated_revenue": {
"amount": "TM001",
"currency": "SGD"
},
"account_purpose": [],
"identification": {
"type": "PASSPORT",
"id_number": "A12345678",
"documents": {
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
},
"remark": "Valid until 2030",
"citizenship_status": "non_resident"
},
"first_name": "三",
"last_name": "张",
"local_name": "张三",
"tax_number": "123-45-6789",
"other_purpose": "<string>"
},
"residential_address": {
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
},
"documents": [
{
"type": "PROOF_OF_ADDRESS",
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
],
"tos_acceptance": {
"ip": "0.0.0.0",
"date": "2024-03-22T16:08:02+08:00",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
}
}
headers = {
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-auth-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_type: 'INDIVIDUAL',
name: 'John Doe',
contact_details: {email: 'example@company.com', phone: '+6588880000'},
person_details: {
first_name_english: 'John',
last_name_english: 'Doe',
nationality: 'US',
date_of_birth: '1990-01-01',
banking_currencies: ['USD'],
banking_countries: ['US'],
monthly_estimated_revenue: {amount: 'TM001', currency: 'SGD'},
account_purpose: [],
identification: {
type: 'PASSPORT',
id_number: 'A12345678',
documents: {
front: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
front_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395',
back: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
back_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395'
},
remark: 'Valid until 2030',
citizenship_status: 'non_resident'
},
first_name: '三',
last_name: '张',
local_name: '张三',
tax_number: '123-45-6789',
other_purpose: '<string>'
},
residential_address: {
city: 'Singapore',
country: 'SG',
line1: '9 N Buona Vista Dr',
state: 'SG',
postal_code: '138666',
line2: 'THE METROPOLIS'
},
documents: [
{
type: 'PROOF_OF_ADDRESS',
front: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
front_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395',
back: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
back_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395'
}
],
tos_acceptance: {
ip: '0.0.0.0',
date: '2024-03-22T16:08:02+08:00',
user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0'
}
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entity_type' => 'INDIVIDUAL',
'name' => 'John Doe',
'contact_details' => [
'email' => 'example@company.com',
'phone' => '+6588880000'
],
'person_details' => [
'first_name_english' => 'John',
'last_name_english' => 'Doe',
'nationality' => 'US',
'date_of_birth' => '1990-01-01',
'banking_currencies' => [
'USD'
],
'banking_countries' => [
'US'
],
'monthly_estimated_revenue' => [
'amount' => 'TM001',
'currency' => 'SGD'
],
'account_purpose' => [
],
'identification' => [
'type' => 'PASSPORT',
'id_number' => 'A12345678',
'documents' => [
'front' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'front_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395',
'back' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'back_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395'
],
'remark' => 'Valid until 2030',
'citizenship_status' => 'non_resident'
],
'first_name' => '三',
'last_name' => '张',
'local_name' => '张三',
'tax_number' => '123-45-6789',
'other_purpose' => '<string>'
],
'residential_address' => [
'city' => 'Singapore',
'country' => 'SG',
'line1' => '9 N Buona Vista Dr',
'state' => 'SG',
'postal_code' => '138666',
'line2' => 'THE METROPOLIS'
],
'documents' => [
[
'type' => 'PROOF_OF_ADDRESS',
'front' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'front_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395',
'back' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'back_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395'
]
],
'tos_acceptance' => [
'ip' => '0.0.0.0',
'date' => '2024-03-22T16:08:02+08:00',
'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v1/accounts"
payload := strings.NewReader("{\n \"entity_type\": \"INDIVIDUAL\",\n \"name\": \"John Doe\",\n \"contact_details\": {\n \"email\": \"example@company.com\",\n \"phone\": \"+6588880000\"\n },\n \"person_details\": {\n \"first_name_english\": \"John\",\n \"last_name_english\": \"Doe\",\n \"nationality\": \"US\",\n \"date_of_birth\": \"1990-01-01\",\n \"banking_currencies\": [\n \"USD\"\n ],\n \"banking_countries\": [\n \"US\"\n ],\n \"monthly_estimated_revenue\": {\n \"amount\": \"TM001\",\n \"currency\": \"SGD\"\n },\n \"account_purpose\": [],\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"id_number\": \"A12345678\",\n \"documents\": {\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n },\n \"remark\": \"Valid until 2030\",\n \"citizenship_status\": \"non_resident\"\n },\n \"first_name\": \"三\",\n \"last_name\": \"张\",\n \"local_name\": \"张三\",\n \"tax_number\": \"123-45-6789\",\n \"other_purpose\": \"<string>\"\n },\n \"residential_address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"9 N Buona Vista Dr\",\n \"state\": \"SG\",\n \"postal_code\": \"138666\",\n \"line2\": \"THE METROPOLIS\"\n },\n \"documents\": [\n {\n \"type\": \"PROOF_OF_ADDRESS\",\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ],\n \"tos_acceptance\": {\n \"ip\": \"0.0.0.0\",\n \"date\": \"2024-03-22T16:08:02+08:00\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v1/accounts")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_type\": \"INDIVIDUAL\",\n \"name\": \"John Doe\",\n \"contact_details\": {\n \"email\": \"example@company.com\",\n \"phone\": \"+6588880000\"\n },\n \"person_details\": {\n \"first_name_english\": \"John\",\n \"last_name_english\": \"Doe\",\n \"nationality\": \"US\",\n \"date_of_birth\": \"1990-01-01\",\n \"banking_currencies\": [\n \"USD\"\n ],\n \"banking_countries\": [\n \"US\"\n ],\n \"monthly_estimated_revenue\": {\n \"amount\": \"TM001\",\n \"currency\": \"SGD\"\n },\n \"account_purpose\": [],\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"id_number\": \"A12345678\",\n \"documents\": {\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n },\n \"remark\": \"Valid until 2030\",\n \"citizenship_status\": \"non_resident\"\n },\n \"first_name\": \"三\",\n \"last_name\": \"张\",\n \"local_name\": \"张三\",\n \"tax_number\": \"123-45-6789\",\n \"other_purpose\": \"<string>\"\n },\n \"residential_address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"9 N Buona Vista Dr\",\n \"state\": \"SG\",\n \"postal_code\": \"138666\",\n \"line2\": \"THE METROPOLIS\"\n },\n \"documents\": [\n {\n \"type\": \"PROOF_OF_ADDRESS\",\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ],\n \"tos_acceptance\": {\n \"ip\": \"0.0.0.0\",\n \"date\": \"2024-03-22T16:08:02+08:00\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_type\": \"INDIVIDUAL\",\n \"name\": \"John Doe\",\n \"contact_details\": {\n \"email\": \"example@company.com\",\n \"phone\": \"+6588880000\"\n },\n \"person_details\": {\n \"first_name_english\": \"John\",\n \"last_name_english\": \"Doe\",\n \"nationality\": \"US\",\n \"date_of_birth\": \"1990-01-01\",\n \"banking_currencies\": [\n \"USD\"\n ],\n \"banking_countries\": [\n \"US\"\n ],\n \"monthly_estimated_revenue\": {\n \"amount\": \"TM001\",\n \"currency\": \"SGD\"\n },\n \"account_purpose\": [],\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"id_number\": \"A12345678\",\n \"documents\": {\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n },\n \"remark\": \"Valid until 2030\",\n \"citizenship_status\": \"non_resident\"\n },\n \"first_name\": \"三\",\n \"last_name\": \"张\",\n \"local_name\": \"张三\",\n \"tax_number\": \"123-45-6789\",\n \"other_purpose\": \"<string>\"\n },\n \"residential_address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"9 N Buona Vista Dr\",\n \"state\": \"SG\",\n \"postal_code\": \"138666\",\n \"line2\": \"THE METROPOLIS\"\n },\n \"documents\": [\n {\n \"type\": \"PROOF_OF_ADDRESS\",\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ],\n \"tos_acceptance\": {\n \"ip\": \"0.0.0.0\",\n \"date\": \"2024-03-22T16:08:02+08:00\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0\"\n }\n}"
response = http.request(request)
puts response.read_body{
"account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
"short_reference_id": "P220406-LLCVLRM",
"status": "PROCESSING",
"verification_status": "APPROVED"
}Accounts
Create Account
This endpoint is no longer maintained. It remains available only to support existing customers. New integrations should use Create Sub Account instead.
Create an account so they can start receiving payments. Once created, we will run due diligence checks. Please note that currently this API is only for Banking accounts.
POST
/
v1
/
accounts
Create Account
curl --request POST \
--url https://api-sandbox.uqpaytech.com/api/v1/accounts \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <api-key>' \
--data '
{
"entity_type": "INDIVIDUAL",
"name": "John Doe",
"contact_details": {
"email": "example@company.com",
"phone": "+6588880000"
},
"person_details": {
"first_name_english": "John",
"last_name_english": "Doe",
"nationality": "US",
"date_of_birth": "1990-01-01",
"banking_currencies": [
"USD"
],
"banking_countries": [
"US"
],
"monthly_estimated_revenue": {
"amount": "TM001",
"currency": "SGD"
},
"account_purpose": [],
"identification": {
"type": "PASSPORT",
"id_number": "A12345678",
"documents": {
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
},
"remark": "Valid until 2030",
"citizenship_status": "non_resident"
},
"first_name": "三",
"last_name": "张",
"local_name": "张三",
"tax_number": "123-45-6789",
"other_purpose": "<string>"
},
"residential_address": {
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
},
"documents": [
{
"type": "PROOF_OF_ADDRESS",
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
],
"tos_acceptance": {
"ip": "0.0.0.0",
"date": "2024-03-22T16:08:02+08:00",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
}
}
'import requests
url = "https://api-sandbox.uqpaytech.com/api/v1/accounts"
payload = {
"entity_type": "INDIVIDUAL",
"name": "John Doe",
"contact_details": {
"email": "example@company.com",
"phone": "+6588880000"
},
"person_details": {
"first_name_english": "John",
"last_name_english": "Doe",
"nationality": "US",
"date_of_birth": "1990-01-01",
"banking_currencies": ["USD"],
"banking_countries": ["US"],
"monthly_estimated_revenue": {
"amount": "TM001",
"currency": "SGD"
},
"account_purpose": [],
"identification": {
"type": "PASSPORT",
"id_number": "A12345678",
"documents": {
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
},
"remark": "Valid until 2030",
"citizenship_status": "non_resident"
},
"first_name": "三",
"last_name": "张",
"local_name": "张三",
"tax_number": "123-45-6789",
"other_purpose": "<string>"
},
"residential_address": {
"city": "Singapore",
"country": "SG",
"line1": "9 N Buona Vista Dr",
"state": "SG",
"postal_code": "138666",
"line2": "THE METROPOLIS"
},
"documents": [
{
"type": "PROOF_OF_ADDRESS",
"front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
"back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
"back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
}
],
"tos_acceptance": {
"ip": "0.0.0.0",
"date": "2024-03-22T16:08:02+08:00",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
}
}
headers = {
"x-auth-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-auth-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_type: 'INDIVIDUAL',
name: 'John Doe',
contact_details: {email: 'example@company.com', phone: '+6588880000'},
person_details: {
first_name_english: 'John',
last_name_english: 'Doe',
nationality: 'US',
date_of_birth: '1990-01-01',
banking_currencies: ['USD'],
banking_countries: ['US'],
monthly_estimated_revenue: {amount: 'TM001', currency: 'SGD'},
account_purpose: [],
identification: {
type: 'PASSPORT',
id_number: 'A12345678',
documents: {
front: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
front_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395',
back: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
back_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395'
},
remark: 'Valid until 2030',
citizenship_status: 'non_resident'
},
first_name: '三',
last_name: '张',
local_name: '张三',
tax_number: '123-45-6789',
other_purpose: '<string>'
},
residential_address: {
city: 'Singapore',
country: 'SG',
line1: '9 N Buona Vista Dr',
state: 'SG',
postal_code: '138666',
line2: 'THE METROPOLIS'
},
documents: [
{
type: 'PROOF_OF_ADDRESS',
front: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
front_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395',
back: 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
back_file_id: '5135e6cc-28b6-4889-81dc-3b86a09e1395'
}
],
tos_acceptance: {
ip: '0.0.0.0',
date: '2024-03-22T16:08:02+08:00',
user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0'
}
})
};
fetch('https://api-sandbox.uqpaytech.com/api/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entity_type' => 'INDIVIDUAL',
'name' => 'John Doe',
'contact_details' => [
'email' => 'example@company.com',
'phone' => '+6588880000'
],
'person_details' => [
'first_name_english' => 'John',
'last_name_english' => 'Doe',
'nationality' => 'US',
'date_of_birth' => '1990-01-01',
'banking_currencies' => [
'USD'
],
'banking_countries' => [
'US'
],
'monthly_estimated_revenue' => [
'amount' => 'TM001',
'currency' => 'SGD'
],
'account_purpose' => [
],
'identification' => [
'type' => 'PASSPORT',
'id_number' => 'A12345678',
'documents' => [
'front' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'front_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395',
'back' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'back_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395'
],
'remark' => 'Valid until 2030',
'citizenship_status' => 'non_resident'
],
'first_name' => '三',
'last_name' => '张',
'local_name' => '张三',
'tax_number' => '123-45-6789',
'other_purpose' => '<string>'
],
'residential_address' => [
'city' => 'Singapore',
'country' => 'SG',
'line1' => '9 N Buona Vista Dr',
'state' => 'SG',
'postal_code' => '138666',
'line2' => 'THE METROPOLIS'
],
'documents' => [
[
'type' => 'PROOF_OF_ADDRESS',
'front' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'front_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395',
'back' => 'data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=',
'back_file_id' => '5135e6cc-28b6-4889-81dc-3b86a09e1395'
]
],
'tos_acceptance' => [
'ip' => '0.0.0.0',
'date' => '2024-03-22T16:08:02+08:00',
'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.uqpaytech.com/api/v1/accounts"
payload := strings.NewReader("{\n \"entity_type\": \"INDIVIDUAL\",\n \"name\": \"John Doe\",\n \"contact_details\": {\n \"email\": \"example@company.com\",\n \"phone\": \"+6588880000\"\n },\n \"person_details\": {\n \"first_name_english\": \"John\",\n \"last_name_english\": \"Doe\",\n \"nationality\": \"US\",\n \"date_of_birth\": \"1990-01-01\",\n \"banking_currencies\": [\n \"USD\"\n ],\n \"banking_countries\": [\n \"US\"\n ],\n \"monthly_estimated_revenue\": {\n \"amount\": \"TM001\",\n \"currency\": \"SGD\"\n },\n \"account_purpose\": [],\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"id_number\": \"A12345678\",\n \"documents\": {\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n },\n \"remark\": \"Valid until 2030\",\n \"citizenship_status\": \"non_resident\"\n },\n \"first_name\": \"三\",\n \"last_name\": \"张\",\n \"local_name\": \"张三\",\n \"tax_number\": \"123-45-6789\",\n \"other_purpose\": \"<string>\"\n },\n \"residential_address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"9 N Buona Vista Dr\",\n \"state\": \"SG\",\n \"postal_code\": \"138666\",\n \"line2\": \"THE METROPOLIS\"\n },\n \"documents\": [\n {\n \"type\": \"PROOF_OF_ADDRESS\",\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ],\n \"tos_acceptance\": {\n \"ip\": \"0.0.0.0\",\n \"date\": \"2024-03-22T16:08:02+08:00\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-auth-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v1/accounts")
.header("x-auth-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_type\": \"INDIVIDUAL\",\n \"name\": \"John Doe\",\n \"contact_details\": {\n \"email\": \"example@company.com\",\n \"phone\": \"+6588880000\"\n },\n \"person_details\": {\n \"first_name_english\": \"John\",\n \"last_name_english\": \"Doe\",\n \"nationality\": \"US\",\n \"date_of_birth\": \"1990-01-01\",\n \"banking_currencies\": [\n \"USD\"\n ],\n \"banking_countries\": [\n \"US\"\n ],\n \"monthly_estimated_revenue\": {\n \"amount\": \"TM001\",\n \"currency\": \"SGD\"\n },\n \"account_purpose\": [],\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"id_number\": \"A12345678\",\n \"documents\": {\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n },\n \"remark\": \"Valid until 2030\",\n \"citizenship_status\": \"non_resident\"\n },\n \"first_name\": \"三\",\n \"last_name\": \"张\",\n \"local_name\": \"张三\",\n \"tax_number\": \"123-45-6789\",\n \"other_purpose\": \"<string>\"\n },\n \"residential_address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"9 N Buona Vista Dr\",\n \"state\": \"SG\",\n \"postal_code\": \"138666\",\n \"line2\": \"THE METROPOLIS\"\n },\n \"documents\": [\n {\n \"type\": \"PROOF_OF_ADDRESS\",\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ],\n \"tos_acceptance\": {\n \"ip\": \"0.0.0.0\",\n \"date\": \"2024-03-22T16:08:02+08:00\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.uqpaytech.com/api/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_type\": \"INDIVIDUAL\",\n \"name\": \"John Doe\",\n \"contact_details\": {\n \"email\": \"example@company.com\",\n \"phone\": \"+6588880000\"\n },\n \"person_details\": {\n \"first_name_english\": \"John\",\n \"last_name_english\": \"Doe\",\n \"nationality\": \"US\",\n \"date_of_birth\": \"1990-01-01\",\n \"banking_currencies\": [\n \"USD\"\n ],\n \"banking_countries\": [\n \"US\"\n ],\n \"monthly_estimated_revenue\": {\n \"amount\": \"TM001\",\n \"currency\": \"SGD\"\n },\n \"account_purpose\": [],\n \"identification\": {\n \"type\": \"PASSPORT\",\n \"id_number\": \"A12345678\",\n \"documents\": {\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n },\n \"remark\": \"Valid until 2030\",\n \"citizenship_status\": \"non_resident\"\n },\n \"first_name\": \"三\",\n \"last_name\": \"张\",\n \"local_name\": \"张三\",\n \"tax_number\": \"123-45-6789\",\n \"other_purpose\": \"<string>\"\n },\n \"residential_address\": {\n \"city\": \"Singapore\",\n \"country\": \"SG\",\n \"line1\": \"9 N Buona Vista Dr\",\n \"state\": \"SG\",\n \"postal_code\": \"138666\",\n \"line2\": \"THE METROPOLIS\"\n },\n \"documents\": [\n {\n \"type\": \"PROOF_OF_ADDRESS\",\n \"front\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"front_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\",\n \"back\": \"data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=\",\n \"back_file_id\": \"5135e6cc-28b6-4889-81dc-3b86a09e1395\"\n }\n ],\n \"tos_acceptance\": {\n \"ip\": \"0.0.0.0\",\n \"date\": \"2024-03-22T16:08:02+08:00\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0\"\n }\n}"
response = http.request(request)
puts response.read_body{
"account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
"short_reference_id": "P220406-LLCVLRM",
"status": "PROCESSING",
"verification_status": "APPROVED"
}Authorizations
The API token for login provided by UQPay.
Body
application/json
Select one of the following entity type.
- Individual Account
- Company Account
Information about the individual applying for the account. This field is available for INDIVIDUAL.
Type of account. This field is mandatory and must be one of:
COMPANY- A entity formed to engage in commercial.INDIVIDUAL- A single person from business contexts. Currently only available for Banking.
Available options:
COMPANY, INDIVIDUAL Example:
"INDIVIDUAL"
Nickname, will be displayed in the Dashboard when selecting account.
Example:
"John Doe"
Show child attributes
Show child attributes
Personal information of the individual account holder.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Identity verification documents submitted for the individual account.
Show child attributes
Show child attributes
Details on the account's acceptance of the UQPAY Services Agreement. This property can only be updated for Custom accounts.
Show child attributes
Show child attributes
Response
200 - application/json
Account creation successfully.
A unique identifier of the account.
Example:
"f5bb6498-552e-40a5-b14b-616aa04ac1c1"
The short reference ID of the account.
Example:
"P220406-LLCVLRM"
Status of the account. One of the following:
- ACTIVE - The account has been activated.
- PROCESSING - The account is currently undergoing review and processing.
- INACTIVE - The account temporarily inactive
- CLOSED - The account has been closed.
Example:
"PROCESSING"
Status of the KYC/KYB. One of the following:
- REJECT - The account has been rejected during identity verification.
- APPROVED - The account has been verified and is active.
- PENDING - The account is currently undergoing identity verification.
- EXPIRED - The verification has expired.
- RETURN - The account has been returned for identity verification and needs to be re-uploaded.
Webhook note: In the accountStatus webhook notification, these two
states are delivered as REJECTED and RETURNED respectively (rather than
REJECT / RETURN). All other values are identical. See
Account Status webhook.
Available options:
APPROVED, PENDING, REJECT, EXPIRED, RETURN Example:
"APPROVED"
⌘I