Get Started

Customer Profile API

📗

Learn how to use the Customer Profile API to create profiles for your Singapore or Indonesia users.

📌

Connect User Migration

For migrating existing users to Customer Profiles, click here.

Overview

The Customer Profile API allows you to create customer profiles for your users. These customer profiles are used as identifiers for us to create virtual account payment methods for your users. This allows you to accept payments of up to $200,000 per transaction.

Singapore

  • Complete the verification process on the StraitsX Business Dashboard by submitting the relevant documents.
  • You can retrieve your Sandbox API keys on the Sandbox Developer Tools Page. (See more)
  • This API key will be used as an identifier and allow you to easily link profiles to your platform.
  • You will need your X-XFERS-APP-API-KEY to create a customer profile.

Indonesia

  • Complete the verification process on the StraitsX Business Dashboard by submitting the relevant documents.
  • Once your business account has been approved, we will generate the API keys for you under the Developer Tools tab.
  • This API key will be used as an identifier and allow you to easily link profiles to your platform.
  • You will need your X-XFERS-APP-API-KEY to create a customer profile.

Still awaiting verification? Contact our Support team to generate a sandbox API key to start testing.

👍

Customer Profiles for New Users

Learn how to onboard your users to the Customer Profile Flow

2407

SG Customer Profile Example

For creating an ID customer profile, click here.
681

ID Customer Profile Example (Last updated: 20 Jun 22)

curl --location --request POST 'https://sandbox.xfers.io/api/v3/kyc/customer_profiles' \
--header 'X-XFERS-APP-API-KEY: t4wsjxpwtk6o9tz20j4baj4ifwibin100py1vrvfsqh' \
--form 'customerName="John Ng"' \
--form 'registrationType="personal"' \
--form 'registrationId="S98763329P"' \
--form 'countryOfResidence="Singapore"' \
--form 'dateOfBirth="1994-11-29"' \
--form 'gender="MALE"' \
--form 'nationality="Singaporean"'
curl --location --request POST 'https://www.xfers.io/api/v3/kyc/customer_profiles' \
--header 'X-XFERS-APP-API-KEY: {{APP_API_KEY}}' \
--form 'customerName="{{CUSTOMER_NAME}}"' \
--form 'registrationType="personal"' \
--form 'registrationId="{{NRIC}}"' \
--form 'countryOfResidence="{{COUNTRY}}"' \
--form 'dateOfBirth="{{DOB}}"' \
--form 'gender="{{GENDER}}"' \
--form 'nationality="{{NATIONALITY}}"'
curl --location --request POST 'https://sandbox.xfers.io/api/v3/kyc/customer_profiles' \
--header 'X-XFERS-APP-API-KEY: KVBZxX2YVOxlSjbxH0j6Wpc408FJKv88zXHU2aewdyO' \
--form 'customerName="John Doe"' \
--form 'registrationType="personal"' \
--form 'registrationId="1233333333"' \
--form 'address="Jl. Prof. DR. Satrio Blok C4 No.25, RT.14/RW.4, Kuningan, Kuningan Tim., Kecamatan Setiabudi, Wil. Kota Jakarta Selatan, Daerah Khusus Ibukota Jakarta 12950, Indonesia"' \
--form 'countryOfResidence="Indonesia"'
curl --location --request POST 'https://www.xfers.io/api/v3/kyc/customer_profiles' \
--header 'X-XFERS-APP-API-KEY: {{APP_API_KEY}}' \
--form 'customerName="{{CUSTOMER_NAME}}"' \
--form 'registrationType="personal"' \
--form 'registrationId="{{KTP_NO}}"' \
--form 'address="{{ADDRESS}}"' \
--form 'countryOfResidence="{{COUNTRY}}"'

🚧

Selecting the right APP API Key

A SG customer profile can only be created using the XSGD dashboard's APP API Key.
Likewise, an ID customer profile can only be created using the XIDR dashboard's APP API Key.

Customer Profile TypeParameters required
SG BusinesscustomerName
registrationId (UEN)
SG PersonalcustomerName
registrationId (NRIC/Passport No.)
countryOfResidence
dateOfBirth
nationality
ID PersonalcustomerName
registrationId (KTP No.)
countryOfResidence
address
  • Different customer profile details are required based on the region.

  • Collect your user's personal details to generate a customer_profile_id.

  • This information can be collected either via a user form or via Singpass myInfo data (SG only)

And that's it! You're all ready to use the Payment API and Payout API to accept payments and send payouts to your users.


Try it out!

Getting started with StraitsX APIs is easy. Our business development and integration teams will be with you every step of the way. If you have any questions or would like to connect with our team, please do so via Support!