Create a recipient for cross-border payment
Learn how to securely store a beneficiary's details for future cross-border payments, supporting both bank accounts and remittance providers. This guide helps you understand the process of creating reusable recipient profiles for these transfers.
The user in this document pertains to both the individual and business user types.
Sender Account Types
The platform can send remittance transactions from two types of sender entities:
Individual (Consumer)
An individual user is a customer onboarded on the platform by submitting personal information to create their user profile. These users were also required to submit KYC documents and have them approved before they could initiate a remittance transaction.
Business (Corporate)
A business user is a customer onboarded on the platform by submitting business information to create their user profile. These users were also required to submit their KYB documents and have them approved before they could initiate a remittance transaction.
Recipient Account Types
The platform can send remittance transactions to two types of receiving entities:
Individual (Consumer)
Consumer information from the individual will be gathered to ensure compliance with the remittance regulatory standards of the receiving country.
Business (Corporate)
Corporate information from the business will be gathered to ensure compliance with the remittance regulatory standards of the receiving country.
Use Cases
- You want to implement a feature that will allow users to withdraw funds to any local and international bank accounts.
- You want to implement a feature that will allow users to define their beneficiary recipient before performing a cross-border payment transaction.
- You want to implement a feature that will allow an individual user to define an individual recipient (C2C remittance mode).
- You want to implement a feature that will allow a business user to define an individual recipient (B2C remittance mode).
- You want to implement a feature that will allow a business user to define a business recipient (B2B remittance mode).
- You want to implement a feature that will allow users to reuse their previously defined recipients for a cross-border payment.
Prerequisites
- The user profile risk assessment status must not be
risk_flagged. - The user profile must be in an
activestatus. - The user must have an
approvedKYC or KYB status - The user account or wallet must be in an
activestatus. - At least one cross-border payout capability {
LOCAL, SWIFT} is enabled in your program.
API Workflow
1
Retrieve the available corridors (remittance routes) for the program
Before asking the user (sender) any of their intended remittance details, we need to know the available corridors or remittance routes that are enabled in the program.
Corridor enablement will be based on the program configuration (as stated in the contract) along with the remittance rail and SWIFT routes availability.
Call the Get Remittance Corridor List (GET /users/wallet/payouts/remittances/corridors) filtering only the active routes based on the user type of the customer (sender).
Get Remittance Corridor List request (filter by status and user_type [sender], recipient_type [receiver])
CURL
curl --location 'https://{{payouts_base_url}}/{{program_code}}/v2/users/wallet/payouts/remittances/corridors?status=ACTIVE&recipient_type=INDIVIDUAL&user_type=INDIVIDUAL' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Authorization: ••••••'Get Remittance Corridor List response
JSON
{
"pagination": {
"total_records": 5,
"records_per_page": 100,
"total_pages": 1,
"links": {
"self": "https://{{server}}/{{program_code}}/v2/users/wallet/payouts/remittances/corridors?page=1&records_per_page=100&user_type=INDIVIDUAL&recipient_type=INDIVIDUAL"
}
},
"data": [
{
"id": "4b007556de30487d8fd7df0e53d07bd7",
"receiving_country": "United States",
"receiving_country_code": "USA",
"mobile_country_code": "+1",
"user_type": "INDIVIDUAL",
"recipient_type": "INDIVIDUAL",
"institute_type": "BANK",
"payment_rail": "LOCAL",
"charge_types": [],
"currency": "US Dollar",
"currency_code": "USD",
"currency_precision": "2",
"status": "ACTIVE"
},
{
"id": "0823dde9bcf847bc97723395bb7b69aa",
"receiving_country": "United States",
"receiving_country_code": "USA",
"mobile_country_code": "+1",
"user_type": "INDIVIDUAL",
"recipient_type": "INDIVIDUAL",
"institute_type": "BANK",
"payment_rail": "SWIFT",
"charge_types": [
"OUR",
"SHA"
],
"currency": "US Dollar",
"currency_code": "USD",
"currency_precision": "2",
"status": "ACTIVE"
},
{
"id": "1a65c300fe594e18bb1ad9fff831b1b7",
"receiving_country": "United States",
"receiving_country_code": "USA",
"mobile_country_code": "+1",
"user_type": "INDIVIDUAL",
"recipient_type": "INDIVIDUAL",
"institute_type": "BANK",
"payment_rail": "SWIFT",
"charge_types": [
"OUR",
"SHA"
],
"currency": "Singapore Dollar",
"currency_code": "SGD",
"currency_precision": "2",
"status": "ACTIVE"
},
{
"id": "b61d6b7ee37a4708b0c36e9c3cbb7883",
"receiving_country": "United States",
"receiving_country_code": "USA",
"mobile_country_code": "+1",
"user_type": "INDIVIDUAL",
"recipient_type": "INDIVIDUAL",
"institute_type": "BANK",
"payment_rail": "SWIFT",
"charge_types": [
"OUR",
"SHA"
],
"currency": "Euro",
"currency_code": "EUR",
"currency_precision": "2",
"status": "ACTIVE"
},
{
"id": "e6ab8a36a9ca41b7962a2e04948b74ce",
"receiving_country": "United States",
"receiving_country_code": "USA",
"mobile_country_code": "+1",
"user_type": "INDIVIDUAL",
"recipient_type": "INDIVIDUAL",
"institute_type": "BANK",
"payment_rail": "SWIFT",
"charge_types": [
"OUR",
"SHA"
],
"currency": "Pound Sterling",
"currency_code": "GBP",
"currency_precision": "2",
"status": "ACTIVE"
}
]
}
You will need to display the list of active corridors available to your users in your frontend. To help the user choose, you will need to display the additional rail parameters, such as payment_rails and charge_types.
LOCAL
From the corridor list response above, we will see this corridor with a payment_rail set to LOCAL. This means that, if the user decides to use this corridor, his remittance will be sent and processed using the local payment rails that exist in the receiving country.
*There are no available charge_types for LOCAL payment rails. This option is only available on SWIFT.
{
- "id": "4b007556de30487d8fd7df0e53d07bd7",
- "receiving_country": "United States",
- "receiving_country_code": "USA",
- "mobile_country_code": "+1",
- "user_type": "INDIVIDUAL",
- "recipient_type": "INDIVIDUAL",
- "institute_type": "BANK",
- "payment_rail": "LOCAL",
- "charge_types": [],
- "currency": "US Dollar",
- "currency_code": "USD",
- "currency_precision": "2",
- "status": "ACTIVE
}
SWIFT
Subsequently, we will see this corridor with a payment_rail set to SWIFT. If the user (sender) decides to use this corridor, his remittance will be sent and processed using the global SWIFT network from the sender country to the receiving country.
SWIFT transfers also offers charge_types which indicates how the transfer fees will be collected.
SHA- overall fees will be shared between the Sender and the RecipientOUR- the entire fee will be borne by the sender.
*For SHA, the shared fees charged to the recipient will be charged directly by the receiving institution of the recipient the without the pariticipation of MatchMove.
{
- "id": "0823dde9bcf847bc97723395bb7b69aa",
- "receiving_country": "United States",
- "receiving_country_code": "USA",
- "mobile_country_code": "+1",
- "user_type": "INDIVIDUAL",
- "recipient_type": "INDIVIDUAL",
- "institute_type": "BANK",
- "payment_rail": "SWIFT",
- "charge_types": [ "OUR", "SHA" ],
- "currency": "US Dollar",
- "currency_code": "USD",
- "currency_precision": "2",
- "status": "ACTIVE"
}
2
Define a remittance recipient
Once the user has verified that there is an active corridor for his intended recipient country, we can proceed to define a remittance recipient using the following details:
Receiving Country & Currency
The intended recipient region and currency
Sender Type
The user type of the sender e.g., {INDIVIDUAL, BUSINESS}
Receiver Type
The recipient type or the receiver, e.g. {INDIVIDUAL, BUSINESS}
Payment Rail
The intended payment rail, e.g. {LOCAL, SWIFT}
Before we can define a recipient, we will need to know the list of information that is required to define a recipient. Since each region has different regulatory rules and guidelines, the required information on remittance recipients will also differ.
Call Get Remittance Recipient Form (GET /users/wallets/payouts/remittances/recipients/forms) to get the list of information required to define a recipient for a specific remittance route. Since these routes differ from each other, the list or form that contains dynamic fields is based on the region requirements at the time it was queried. As regulatory rules evolve, these field requirements may update from time to time.
Get Remittance Recipient Form request
CURL
curl --location 'https://{{payouts_base_url}}/{{program_code}}/v2/users/wallets/payouts/remittances/recipients/forms?recipient_type=INDIVIDUAL&recipient_country=USA&payment_rail=SWIFT' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Authorization: ••••••'*When the payment_rail filter is not specified, the request will default to LOCAL.
Get Remittance Recipient Form response
JSON
{
"version": "1",
"recipient_form": [
{
"field_group_key": "bank_details",
"field_group_label": "Bank Details",
"fields": [
{
"field_key": "account_number",
"field_label": "Bank Account Number",
"field_type": "string",
"is_mandatory": true,
"is_editable": false,
"validation": {
"max_length": 50,
"min_length": 1,
"regex": "^[a-zA-Z0-9]*$"
},
"field_category": "Bank Details"
},
{
"field_key": "account_name",
"field_label": "Bank Account Name",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "Bank Details"
},
{
"field_key": "account_type",
"field_label": "Bank Account Type",
"field_type": "string",
"is_mandatory": true,
"is_editable": false,
"enum_key": "account_type",
"values_supported": [
{
"code": "SAVINGS_ACCOUNT",
"description": "Savings Account",
"value": "Savings Account"
},
{
"code": "CURRENT_ACCOUNT",
"description": "Current Account",
"value": "Current Account"
}
],
"field_category": "Bank Details"
},
{
"field_key": "code",
"field_label": "SWIFT Code",
"field_type": "string",
"is_mandatory": true,
"is_editable": false,
"validation": {
"max_length": 11,
"min_length": 8,
"regex": "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$"
},
"field_category": "Bank Details"
},
{
"field_key": "bank_id",
"field_label": "Bank Name",
"field_type": "string",
"is_mandatory": true,
"is_editable": false,
"field_category": "Bank Details"
}
]
},
{
"field_group_key": "address_details",
"field_group_label": "Address Details",
"fields": [
{
"field_key": "address_line_1",
"field_label": "Address Line 1",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 30,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,-_)('‘’‚‛′]+$"
},
"field_category": "Address Details"
},
{
"field_key": "address_line_2",
"field_label": "Address Line 2",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 30,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,-_)('‘’‚‛′]+$"
},
"field_category": "Address Details"
},
{
"field_key": "address_line_3",
"field_label": "Address Line 3",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 30,
"min_length": 0,
"regex": "^[#.0-9a-zA-Z\\s,-_)('‘’‚‛′]+$"
},
"field_category": "Address Details"
},
{
"field_key": "address_line_4",
"field_label": "Address Line 4",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 30,
"min_length": 0,
"regex": "^[#.0-9a-zA-Z\\s,-_)('‘’‚‛′]+$"
},
"field_category": "Address Details"
},
{
"field_key": "city",
"field_label": "City",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,-_)('‘’‚‛′]+$"
},
"field_category": "Address Details"
},
{
"field_key": "state",
"field_label": "State/Province",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,-_)('‘’‚‛′]+$"
},
"field_category": "Address Details"
},
{
"field_key": "postal_code",
"field_label": "Postal Code",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 20,
"min_length": 1
},
"field_category": "Address Details"
},
{
"field_key": "country",
"field_label": "Country",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"values_supported": [
{
"code": "AUT",
"description": "Austria",
"value": "Austria"
},
{
"code": "AND",
"description": "Andorra",
"value": "Andorra"
},
{
"code": "ARE",
"description": "United Arab Emirates",
"value": "United Arab Emirates"
},
{
"code": "AFG",
"description": "Afghanistan",
"value": "Afghanistan"
},
{
"code": "ATG",
"description": "Antigua And Barbuda",
"value": "Antigua And Barbuda"
},
{
"code": "AIA",
"description": "Anguilla",
"value": "Anguilla"
},
{
"code": "ALB",
"description": "Albania",
"value": "Albania"
},
{
"code": "ARM",
"description": "Armenia",
"value": "Armenia"
},
{
"code": "AGO",
"description": "Angola",
"value": "Angola"
},
{
"code": "ATA",
"description": "Antarctica",
"value": "Antarctica"
},
{
"code": "ARG",
"description": "Argentina",
"value": "Argentina"
},
{
"code": "ASM",
"description": "American Samoa",
"value": "American Samoa"
},
{
"code": "AUS",
"description": "Australia",
"value": "Australia"
},
{
"code": "ABW",
"description": "Aruba",
"value": "Aruba"
},
{
"code": "ALA",
"description": "Åland Islands",
"value": "Åland Islands"
},
{
"code": "AZE",
"description": "Azerbaijan",
"value": "Azerbaijan"
},
{
"code": "BIH",
"description": "Bosnia & Herzegovina",
"value": "Bosnia & Herzegovina"
},
{
"code": "BRB",
"description": "Barbados",
"value": "Barbados"
},
{
"code": "BGD",
"description": "Bangladesh",
"value": "Bangladesh"
},
{
"code": "BEL",
"description": "Belgium",
"value": "Belgium"
},
{
"code": "BFA",
"description": "Burkina Faso",
"value": "Burkina Faso"
},
{
"code": "BGR",
"description": "Bulgaria",
"value": "Bulgaria"
},
{
"code": "BHR",
"description": "Bahrain",
"value": "Bahrain"
},
{
"code": "BDI",
"description": "Burundi",
"value": "Burundi"
},
{
"code": "BEN",
"description": "Benin",
"value": "Benin"
},
{
"code": "BLM",
"description": "Saint Barthélemy",
"value": "Saint Barthélemy"
},
{
"code": "BMU",
"description": "Bermuda",
"value": "Bermuda"
},
{
"code": "BRN",
"description": "Brunei Darussalam",
"value": "Brunei Darussalam"
},
{
"code": "BOL",
"description": "Bolivia, Plurinational State Of",
"value": "Bolivia, Plurinational State Of"
},
{
"code": "BRA",
"description": "Brazil",
"value": "Brazil"
},
{
"code": "BHS",
"description": "Bahamas",
"value": "Bahamas"
},
{
"code": "BTN",
"description": "Bhutan",
"value": "Bhutan"
},
{
"code": "BVT",
"description": "Bouvet Island",
"value": "Bouvet Island"
},
{
"code": "BWA",
"description": "Botswana",
"value": "Botswana"
},
{
"code": "BLR",
"description": "Belarus",
"value": "Belarus"
},
{
"code": "BLZ",
"description": "Belize",
"value": "Belize"
},
{
"code": "CAN",
"description": "Canada",
"value": "Canada"
},
{
"code": "CCK",
"description": "Cocos (Keeling) Islands",
"value": "Cocos (Keeling) Islands"
},
{
"code": "COD",
"description": "Democratic Republic Of Congo",
"value": "Democratic Republic Of Congo"
},
{
"code": "CAF",
"description": "Central African Republic",
"value": "Central African Republic"
},
{
"code": "COG",
"description": "Republic Of Congo",
"value": "Republic Of Congo"
},
{
"code": "CHE",
"description": "Switzerland",
"value": "Switzerland"
},
{
"code": "CIV",
"description": "Cote d'Ivoire",
"value": "Cote d'Ivoire"
},
{
"code": "COK",
"description": "Cook Islands",
"value": "Cook Islands"
},
{
"code": "CHL",
"description": "Chile",
"value": "Chile"
},
{
"code": "CMR",
"description": "Cameroon",
"value": "Cameroon"
},
{
"code": "CHN",
"description": "China",
"value": "China"
},
{
"code": "COL",
"description": "Colombia",
"value": "Colombia"
},
{
"code": "CRI",
"description": "Costa Rica",
"value": "Costa Rica"
},
{
"code": "CUB",
"description": "Cuba",
"value": "Cuba"
},
{
"code": "CPV",
"description": "Cabo Verde",
"value": "Cabo Verde"
},
{
"code": "CXR",
"description": "Christmas Island",
"value": "Christmas Island"
},
{
"code": "CYP",
"description": "Cyprus",
"value": "Cyprus"
},
{
"code": "CZE",
"description": "Czech Republic",
"value": "Czech Republic"
},
{
"code": "DEU",
"description": "Germany",
"value": "Germany"
},
{
"code": "DJI",
"description": "Djibouti",
"value": "Djibouti"
},
{
"code": "DNK",
"description": "Denmark",
"value": "Denmark"
},
{
"code": "DMA",
"description": "Dominica",
"value": "Dominica"
},
{
"code": "DOM",
"description": "Dominican Republic",
"value": "Dominican Republic"
},
{
"code": "DZA",
"description": "Algeria",
"value": "Algeria"
},
{
"code": "ECU",
"description": "Ecuador",
"value": "Ecuador"
},
{
"code": "EST",
"description": "Estonia",
"value": "Estonia"
},
{
"code": "EGY",
"description": "Egypt",
"value": "Egypt"
},
{
"code": "ESH",
"description": "Western Sahara",
"value": "Western Sahara"
},
{
"code": "ERI",
"description": "Eritrea",
"value": "Eritrea"
},
{
"code": "ESP",
"description": "Spain",
"value": "Spain"
},
{
"code": "ETH",
"description": "Ethiopia",
"value": "Ethiopia"
},
{
"code": "FIN",
"description": "Finland",
"value": "Finland"
},
{
"code": "FJI",
"description": "Fiji",
"value": "Fiji"
},
{
"code": "FLK",
"description": "Falkland Islands",
"value": "Falkland Islands"
},
{
"code": "FSM",
"description": "Micronesia, Federated States Of",
"value": "Micronesia, Federated States Of"
},
{
"code": "FRO",
"description": "Faroe Islands",
"value": "Faroe Islands"
},
{
"code": "FRA",
"description": "France",
"value": "France"
},
{
"code": "FXX",
"description": "France, Metropolitan",
"value": "France, Metropolitan"
},
{
"code": "GAB",
"description": "Gabon",
"value": "Gabon"
},
{
"code": "GBR",
"description": "United Kingdom",
"value": "United Kingdom"
},
{
"code": "GRD",
"description": "Grenada",
"value": "Grenada"
},
{
"code": "GEO",
"description": "Georgia",
"value": "Georgia"
},
{
"code": "GUF",
"description": "French Guiana",
"value": "French Guiana"
},
{
"code": "GGY",
"description": "Guernsey",
"value": "Guernsey"
},
{
"code": "GHA",
"description": "Ghana",
"value": "Ghana"
},
{
"code": "GIB",
"description": "Gibraltar",
"value": "Gibraltar"
},
{
"code": "GRL",
"description": "Greenland",
"value": "Greenland"
},
{
"code": "GMB",
"description": "Gambia",
"value": "Gambia"
},
{
"code": "GIN",
"description": "Guinea",
"value": "Guinea"
},
{
"code": "GLP",
"description": "Guadeloupe",
"value": "Guadeloupe"
},
{
"code": "GNQ",
"description": "Equatorial Guinea",
"value": "Equatorial Guinea"
},
{
"code": "GRC",
"description": "Greece",
"value": "Greece"
},
{
"code": "SGS",
"description": "South Georgia And The South Sandwich Islands",
"value": "South Georgia And The South Sandwich Islands"
},
{
"code": "GTM",
"description": "Guatemala",
"value": "Guatemala"
},
{
"code": "GUM",
"description": "Guam",
"value": "Guam"
},
{
"code": "GNB",
"description": "Guinea-bissau",
"value": "Guinea-bissau"
},
{
"code": "GUY",
"description": "Guyana",
"value": "Guyana"
},
{
"code": "HKG",
"description": "Hong Kong",
"value": "Hong Kong"
},
{
"code": "HMD",
"description": "Heard Island And McDonald Islands",
"value": "Heard Island And McDonald Islands"
},
{
"code": "HND",
"description": "Honduras",
"value": "Honduras"
},
{
"code": "HRV",
"description": "Croatia",
"value": "Croatia"
},
{
"code": "HTI",
"description": "Haiti",
"value": "Haiti"
},
{
"code": "HUN",
"description": "Hungary",
"value": "Hungary"
},
{
"code": "IDN",
"description": "Indonesia",
"value": "Indonesia"
},
{
"code": "IRL",
"description": "Ireland",
"value": "Ireland"
},
{
"code": "ISR",
"description": "Israel",
"value": "Israel"
},
{
"code": "IMN",
"description": "Isle Of Man",
"value": "Isle Of Man"
},
{
"code": "IND",
"description": "India",
"value": "India"
},
{
"code": "IOT",
"description": "British Indian Ocean Territory",
"value": "British Indian Ocean Territory"
},
{
"code": "IRQ",
"description": "Iraq",
"value": "Iraq"
},
{
"code": "IRN",
"description": "Iran, Islamic Republic Of",
"value": "Iran, Islamic Republic Of"
},
{
"code": "ISL",
"description": "Iceland",
"value": "Iceland"
},
{
"code": "ITA",
"description": "Italy",
"value": "Italy"
},
{
"code": "JEY",
"description": "Jersey",
"value": "Jersey"
},
{
"code": "JAM",
"description": "Jamaica",
"value": "Jamaica"
},
{
"code": "JOR",
"description": "Jordan",
"value": "Jordan"
},
{
"code": "JPN",
"description": "Japan",
"value": "Japan"
},
{
"code": "KEN",
"description": "Kenya",
"value": "Kenya"
},
{
"code": "KGZ",
"description": "Kyrgyzstan",
"value": "Kyrgyzstan"
},
{
"code": "KHM",
"description": "Cambodia",
"value": "Cambodia"
},
{
"code": "KIR",
"description": "Kiribati",
"value": "Kiribati"
},
{
"code": "COM",
"description": "Comoros",
"value": "Comoros"
},
{
"code": "KNA",
"description": "Saint Kitts And Nevis",
"value": "Saint Kitts And Nevis"
},
{
"code": "PRK",
"description": "Korea, Democratic People's Republic Of",
"value": "Korea, Democratic People's Republic Of"
},
{
"code": "KOR",
"description": "Korea, Republic Of",
"value": "Korea, Republic Of"
},
{
"code": "KWT",
"description": "Kuwait",
"value": "Kuwait"
},
{
"code": "CYM",
"description": "Cayman Islands",
"value": "Cayman Islands"
},
{
"code": "KAZ",
"description": "Kazakhstan",
"value": "Kazakhstan"
},
{
"code": "LAO",
"description": "Lao People's Democratic Republic",
"value": "Lao People's Democratic Republic"
},
{
"code": "LBN",
"description": "Lebanon",
"value": "Lebanon"
},
{
"code": "LCA",
"description": "Saint Lucia",
"value": "Saint Lucia"
},
{
"code": "LIE",
"description": "Liechtenstein",
"value": "Liechtenstein"
},
{
"code": "LKA",
"description": "Sri Lanka",
"value": "Sri Lanka"
},
{
"code": "LBR",
"description": "Liberia",
"value": "Liberia"
},
{
"code": "LSO",
"description": "Lesotho",
"value": "Lesotho"
},
{
"code": "LTU",
"description": "Lithuania",
"value": "Lithuania"
},
{
"code": "LUX",
"description": "Luxembourg",
"value": "Luxembourg"
},
{
"code": "LVA",
"description": "Latvia",
"value": "Latvia"
},
{
"code": "LBY",
"description": "Libya",
"value": "Libya"
},
{
"code": "MAR",
"description": "Morocco",
"value": "Morocco"
},
{
"code": "MCO",
"description": "Monaco",
"value": "Monaco"
},
{
"code": "MDA",
"description": "Moldova",
"value": "Moldova"
},
{
"code": "MNE",
"description": "Montenegro",
"value": "Montenegro"
},
{
"code": "MAF",
"description": "Saint Martin",
"value": "Saint Martin"
},
{
"code": "MDG",
"description": "Madagascar",
"value": "Madagascar"
},
{
"code": "MHL",
"description": "Marshall Islands",
"value": "Marshall Islands"
},
{
"code": "MKD",
"description": "Macedonia, The Former Yugoslav Republic Of",
"value": "Macedonia, The Former Yugoslav Republic Of"
},
{
"code": "MLI",
"description": "Mali",
"value": "Mali"
},
{
"code": "MMR",
"description": "Myanmar",
"value": "Myanmar"
},
{
"code": "MNG",
"description": "Mongolia",
"value": "Mongolia"
},
{
"code": "MAC",
"description": "Macao",
"value": "Macao"
},
{
"code": "MNP",
"description": "Northern Mariana Islands",
"value": "Northern Mariana Islands"
},
{
"code": "MTQ",
"description": "Martinique",
"value": "Martinique"
},
{
"code": "MRT",
"description": "Mauritania",
"value": "Mauritania"
},
{
"code": "MSR",
"description": "Montserrat",
"value": "Montserrat"
},
{
"code": "MLT",
"description": "Malta",
"value": "Malta"
},
{
"code": "MUS",
"description": "Mauritius",
"value": "Mauritius"
},
{
"code": "MDV",
"description": "Maldives",
"value": "Maldives"
},
{
"code": "MWI",
"description": "Malawi",
"value": "Malawi"
},
{
"code": "MEX",
"description": "Mexico",
"value": "Mexico"
},
{
"code": "MYS",
"description": "Malaysia",
"value": "Malaysia"
},
{
"code": "MOZ",
"description": "Mozambique",
"value": "Mozambique"
},
{
"code": "NAM",
"description": "Namibia",
"value": "Namibia"
},
{
"code": "NCL",
"description": "New Caledonia",
"value": "New Caledonia"
},
{
"code": "NER",
"description": "Niger",
"value": "Niger"
},
{
"code": "NFK",
"description": "Norfolk Island",
"value": "Norfolk Island"
},
{
"code": "NGA",
"description": "Nigeria",
"value": "Nigeria"
},
{
"code": "NIC",
"description": "Nicaragua",
"value": "Nicaragua"
},
{
"code": "NLD",
"description": "Netherlands",
"value": "Netherlands"
},
{
"code": "NOR",
"description": "Norway",
"value": "Norway"
},
{
"code": "NPL",
"description": "Nepal",
"value": "Nepal"
},
{
"code": "NRU",
"description": "Nauru",
"value": "Nauru"
},
{
"code": "NIU",
"description": "Niue",
"value": "Niue"
},
{
"code": "NZL",
"description": "New Zealand",
"value": "New Zealand"
},
{
"code": "OMN",
"description": "Oman",
"value": "Oman"
},
{
"code": "PAN",
"description": "Panama",
"value": "Panama"
},
{
"code": "PER",
"description": "Peru",
"value": "Peru"
},
{
"code": "PYF",
"description": "French Polynesia",
"value": "French Polynesia"
},
{
"code": "PNG",
"description": "Papua New Guinea",
"value": "Papua New Guinea"
},
{
"code": "PHL",
"description": "Philippines",
"value": "Philippines"
},
{
"code": "PAK",
"description": "Pakistan",
"value": "Pakistan"
},
{
"code": "POL",
"description": "Poland",
"value": "Poland"
},
{
"code": "SPM",
"description": "Saint Pierre And Miquelon",
"value": "Saint Pierre And Miquelon"
},
{
"code": "PCN",
"description": "Pitcairn",
"value": "Pitcairn"
},
{
"code": "PRI",
"description": "Puerto Rico",
"value": "Puerto Rico"
},
{
"code": "PSE",
"description": "Palestinian Territory, Occupied",
"value": "Palestinian Territory, Occupied"
},
{
"code": "PRT",
"description": "Portugal",
"value": "Portugal"
},
{
"code": "PLW",
"description": "Palau",
"value": "Palau"
},
{
"code": "PRY",
"description": "Paraguay",
"value": "Paraguay"
},
{
"code": "QAT",
"description": "Qatar",
"value": "Qatar"
},
{
"code": "REU",
"description": "Reunion",
"value": "Reunion"
},
{
"code": "ROU",
"description": "Romania",
"value": "Romania"
},
{
"code": "SRB",
"description": "Serbia",
"value": "Serbia"
},
{
"code": "RUS",
"description": "Russian Federation",
"value": "Russian Federation"
},
{
"code": "RWA",
"description": "Rwanda",
"value": "Rwanda"
},
{
"code": "SAU",
"description": "Saudi Arabia",
"value": "Saudi Arabia"
},
{
"code": "SLB",
"description": "Solomon Islands",
"value": "Solomon Islands"
},
{
"code": "SYC",
"description": "Seychelles",
"value": "Seychelles"
},
{
"code": "SDN",
"description": "Sudan",
"value": "Sudan"
},
{
"code": "SWE",
"description": "Sweden",
"value": "Sweden"
},
{
"code": "SGP",
"description": "Singapore",
"value": "Singapore"
},
{
"code": "SHN",
"description": "Saint Helena, Ascension And Tristan Da Cunha",
"value": "Saint Helena, Ascension And Tristan Da Cunha"
},
{
"code": "SVN",
"description": "Slovenia",
"value": "Slovenia"
},
{
"code": "SJM",
"description": "Svalbard And Jan Mayen",
"value": "Svalbard And Jan Mayen"
},
{
"code": "SVK",
"description": "Slovakia",
"value": "Slovakia"
},
{
"code": "SLE",
"description": "Sierra Leone",
"value": "Sierra Leone"
},
{
"code": "SMR",
"description": "San Marino",
"value": "San Marino"
},
{
"code": "SEN",
"description": "Senegal",
"value": "Senegal"
},
{
"code": "SOM",
"description": "Somalia",
"value": "Somalia"
},
{
"code": "SUR",
"description": "Suriname",
"value": "Suriname"
},
{
"code": "SSD",
"description": "South Sudan",
"value": "South Sudan"
},
{
"code": "STP",
"description": "São Tomé and Príncipe",
"value": "São Tomé and Príncipe"
},
{
"code": "SLV",
"description": "El Salvador",
"value": "El Salvador"
},
{
"code": "SYR",
"description": "Syrian Arab Republic",
"value": "Syrian Arab Republic"
},
{
"code": "SWZ",
"description": "Swaziland",
"value": "Swaziland"
},
{
"code": "TCA",
"description": "Turks And Caicos Islands",
"value": "Turks And Caicos Islands"
},
{
"code": "TCD",
"description": "Chad",
"value": "Chad"
},
{
"code": "ATF",
"description": "French Southern Territories",
"value": "French Southern Territories"
},
{
"code": "TGO",
"description": "Togo",
"value": "Togo"
},
{
"code": "THA",
"description": "Thailand",
"value": "Thailand"
},
{
"code": "TJK",
"description": "Tajikistan",
"value": "Tajikistan"
},
{
"code": "TKL",
"description": "Tokelau",
"value": "Tokelau"
},
{
"code": "TLS",
"description": "East Timor",
"value": "East Timor"
},
{
"code": "TKM",
"description": "Turkmenistan",
"value": "Turkmenistan"
},
{
"code": "TUN",
"description": "Tunisia",
"value": "Tunisia"
},
{
"code": "TON",
"description": "Tonga",
"value": "Tonga"
},
{
"code": "TUR",
"description": "Turkey",
"value": "Turkey"
},
{
"code": "TTO",
"description": "Trinidad And Tobago",
"value": "Trinidad And Tobago"
},
{
"code": "TUV",
"description": "Tuvalu",
"value": "Tuvalu"
},
{
"code": "TWN",
"description": "Taiwan, Province Of China",
"value": "Taiwan, Province Of China"
},
{
"code": "TZA",
"description": "Tanzania, United Republic Of",
"value": "Tanzania, United Republic Of"
},
{
"code": "UKR",
"description": "Ukraine",
"value": "Ukraine"
},
{
"code": "UGA",
"description": "Uganda",
"value": "Uganda"
},
{
"code": "UMI",
"description": "United States Minor Outlying Islands",
"value": "United States Minor Outlying Islands"
},
{
"code": "USA",
"description": "United States",
"value": "United States"
},
{
"code": "URY",
"description": "Uruguay",
"value": "Uruguay"
},
{
"code": "UZB",
"description": "Uzbekistan",
"value": "Uzbekistan"
},
{
"code": "VAT",
"description": "Vatican City State",
"value": "Vatican City State"
},
{
"code": "VCT",
"description": "Saint Vincent And The Grenadines",
"value": "Saint Vincent And The Grenadines"
},
{
"code": "VEN",
"description": "Venezuela, Bolivarian Republic Of",
"value": "Venezuela, Bolivarian Republic Of"
},
{
"code": "VGB",
"description": "Virgin Islands (British)",
"value": "Virgin Islands (British)"
},
{
"code": "VIR",
"description": "Virgin Islands (US)",
"value": "Virgin Islands (US)"
},
{
"code": "VNM",
"description": "Vietnam",
"value": "Vietnam"
},
{
"code": "VUT",
"description": "Vanuatu",
"value": "Vanuatu"
},
{
"code": "WLF",
"description": "Wallis And Futuna",
"value": "Wallis And Futuna"
},
{
"code": "WSM",
"description": "Samoa",
"value": "Samoa"
},
{
"code": "YEM",
"description": "Yemen",
"value": "Yemen"
},
{
"code": "MYT",
"description": "Mayotte",
"value": "Mayotte"
},
{
"code": "ZAF",
"description": "South Africa",
"value": "South Africa"
},
{
"code": "ZMB",
"description": "Zambia",
"value": "Zambia"
},
{
"code": "ZWE",
"description": "Zimbabwe",
"value": "Zimbabwe"
}
],
"field_category": "Address Details"
},
{
"field_key": "nationality",
"field_label": "Nationality",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"enum_key": "nationality",
"values_supported": [
{
"code": "ABW",
"description": "Nationality of Aruba",
"value": "Aruban"
},
{
"code": "AFG",
"description": "Nationality of Afghanistan",
"value": "Afghan"
},
{
"code": "AGO",
"description": "Nationality of Angola",
"value": "Angolan"
},
{
"code": "AIA",
"description": "Nationality of Anguilla",
"value": "Anguillan"
},
{
"code": "ALA",
"description": "Nationality of Aland Islands",
"value": "Landers"
},
{
"code": "ALB",
"description": "Nationality of Albania",
"value": "Albanian"
},
{
"code": "AND",
"description": "Nationality of Andorra",
"value": "Andorran"
},
{
"code": "ANT",
"description": "Nationality of Netherlands Antilles",
"value": "Netherlands Antilles"
},
{
"code": "ARE",
"description": "Nationality of United Arab Emirates",
"value": "United Arab Emirates"
},
{
"code": "ARG",
"description": "Nationality of Argentina",
"value": "Argentinian"
},
{
"code": "ARM",
"description": "Nationality of Armenia",
"value": "Armenian"
},
{
"code": "ASM",
"description": "Nationality of American Samoa",
"value": "American Samoan"
},
{
"code": "ATA",
"description": "Nationality of Antarctica",
"value": "Antarctican"
},
{
"code": "ATF",
"description": "Nationality of French Southern Territories",
"value": "French"
},
{
"code": "ATG",
"description": "Nationality of Antigua and Barbuda",
"value": "Antiguan and Barbudan"
},
{
"code": "AUS",
"description": "Nationality of Australia",
"value": "Australian"
},
{
"code": "AUT",
"description": "Nationality of Austria",
"value": "Austrian"
},
{
"code": "AZE",
"description": "Nationality of Azerbaijan",
"value": "Azerbaijani"
},
{
"code": "BDI",
"description": "Nationality of Burundi",
"value": "Burundian"
},
{
"code": "BEL",
"description": "Nationality of Belgium",
"value": "Belgian"
},
{
"code": "BEN",
"description": "Nationality of Benin",
"value": "Beninese"
},
{
"code": "BFA",
"description": "Nationality of Burkina Faso",
"value": "Burkinab"
},
{
"code": "BGD",
"description": "Nationality of Bangladesh",
"value": "Bangladeshi"
},
{
"code": "BGR",
"description": "Nationality of Bulgaria",
"value": "Bulgarian"
},
{
"code": "BHR",
"description": "Nationality of Bahrain",
"value": "Bahraini"
},
{
"code": "BHS",
"description": "Nationality of Bahamas",
"value": "Bahamian"
},
{
"code": "BIH",
"description": "Nationality of Bosnia and Herzegovina",
"value": "Bosnian"
},
{
"code": "BLM",
"description": "Nationality of Saint Barthelemy",
"value": "Saint Barth"
},
{
"code": "BLR",
"description": "Nationality of Belarus",
"value": "Belarusan"
},
{
"code": "BLZ",
"description": "Nationality of Belize",
"value": "Belizian"
},
{
"code": "BMU",
"description": "Nationality of Bermuda",
"value": "Bermudian"
},
{
"code": "BOL",
"description": "Nationality of Bolivia",
"value": "Bolivian"
},
{
"code": "BRA",
"description": "Nationality of Brazil",
"value": "Brazilian"
},
{
"code": "BRB",
"description": "Nationality of Barbados",
"value": "Barbadian"
},
{
"code": "BRN",
"description": "Nationality of Brunei Darussalam",
"value": "Bruneian"
},
{
"code": "BTN",
"description": "Nationality of Bhutan",
"value": "Bhutanese"
},
{
"code": "BVT",
"description": "Nationality of Bouvet Island",
"value": "Bouvet Island"
},
{
"code": "BWA",
"description": "Nationality of Botswana",
"value": "Tswana"
},
{
"code": "CAF",
"description": "Nationality of Central African Republic",
"value": "Central African"
},
{
"code": "CAN",
"description": "Nationality of Canada",
"value": "Canadian"
},
{
"code": "CCK",
"description": "Nationality of Cocos (Keeling) Islands",
"value": "Cocos Islander"
},
{
"code": "CHE",
"description": "Nationality of Switzerland",
"value": "Swiss"
},
{
"code": "CHL",
"description": "Nationality of Chile",
"value": "Chilean"
},
{
"code": "CHN",
"description": "Nationality of China",
"value": "Chinese"
},
{
"code": "CIV",
"description": "Nationality of Ivory Coast",
"value": "Ivoirian"
},
{
"code": "CMR",
"description": "Nationality of Cameroon",
"value": "Cameroonian"
},
{
"code": "COD",
"description": "Nationality of Congo, The Democratic Republic",
"value": "Congolese"
},
{
"code": "COG",
"description": "Nationality of Congo",
"value": "Congolese"
},
{
"code": "COK",
"description": "Nationality of Cook Islands",
"value": "Cook Islander"
},
{
"code": "COL",
"description": "Nationality of Colombia",
"value": "Colombian"
},
{
"code": "COM",
"description": "Nationality of Comoros",
"value": "Comoran"
},
{
"code": "CPV",
"description": "Nationality of Cape Verde",
"value": "Cape Verdean"
},
{
"code": "CRI",
"description": "Nationality of Costa Rica",
"value": "Costa Rican"
},
{
"code": "CUB",
"description": "Nationality of Cuba",
"value": "Cuban"
},
{
"code": "CXR",
"description": "Nationality of Christmas Island",
"value": "Christmas Islander"
},
{
"code": "CYM",
"description": "Nationality of Cayman Islands",
"value": "Caymanian"
},
{
"code": "CZE",
"description": "Nationality of Czech Republic",
"value": "Czech"
},
{
"code": "DEU",
"description": "Nationality of Germany",
"value": "German"
},
{
"code": "DJI",
"description": "Nationality of Djibouti",
"value": "Djiboutian"
},
{
"code": "DMA",
"description": "Nationality of Dominica",
"value": "Dominican"
},
{
"code": "DNK",
"description": "Nationality of Denmark",
"value": "Dane"
},
{
"code": "DOM",
"description": "Nationality of Dominican Republic",
"value": "Dominican"
},
{
"code": "DZA",
"description": "Nationality of Algeria",
"value": "Algerian"
},
{
"code": "ECU",
"description": "Nationality of Ecuador",
"value": "Ecuadorean"
},
{
"code": "EGY",
"description": "Nationality of Egypt",
"value": "Egyptian"
},
{
"code": "ERI",
"description": "Nationality of Eritrea",
"value": "Eritrean"
},
{
"code": "ESH",
"description": "Nationality of Western Sahara",
"value": "Western Saharan"
},
{
"code": "ESP",
"description": "Nationality of Spain",
"value": "Spaniard"
},
{
"code": "EST",
"description": "Nationality of Estonia",
"value": "Estonian"
},
{
"code": "ETH",
"description": "Nationality of Ethiopia",
"value": "Ethiopian"
},
{
"code": "FIN",
"description": "Nationality of Finland",
"value": "Finn"
},
{
"code": "FJI",
"description": "Nationality of Fiji",
"value": "Fijian"
},
{
"code": "FLK",
"description": "Nationality of Falkland Islands (Malvinas)",
"value": "Falkland Islander"
},
{
"code": "FRA",
"description": "Nationality of France",
"value": "French"
},
{
"code": "FRO",
"description": "Nationality of Faroe Islands",
"value": "Faroese"
},
{
"code": "FSM",
"description": "Nationality of Micronesia, Federated States o",
"value": "Micronesian"
},
{
"code": "FXX",
"description": "Nationality of France, Metropolitan",
"value": "French"
},
{
"code": "GAB",
"description": "Nationality of Gabon",
"value": "Gabonese"
},
{
"code": "GBR",
"description": "Nationality of United Kingdom",
"value": "British"
},
{
"code": "GEO",
"description": "Nationality of Georgia",
"value": "Georgian"
},
{
"code": "GGY",
"description": "Nationality of Guernsey",
"value": "Channel Islander"
},
{
"code": "GHA",
"description": "Nationality of Ghana",
"value": "Ghanaian"
},
{
"code": "GIB",
"description": "Nationality of Gibraltar",
"value": "Gibraltar"
},
{
"code": "GIN",
"description": "Nationality of Guinea",
"value": "Guinean"
},
{
"code": "GLP",
"description": "Nationality of Guadeloupe",
"value": "Guadeloupian"
},
{
"code": "GMB",
"description": "Nationality of Gambia",
"value": "Gambian"
},
{
"code": "GNB",
"description": "Nationality of Guinea-Bissau",
"value": "Bissau-Guinean"
},
{
"code": "GNQ",
"description": "Nationality of Equatorial Guinea",
"value": "Equatoguinean"
},
{
"code": "GRC",
"description": "Nationality of Greece",
"value": "Greek"
},
{
"code": "GRD",
"description": "Nationality of Grenada",
"value": "Grenadian"
},
{
"code": "GRL",
"description": "Nationality of Greenland",
"value": "Greenlander"
},
{
"code": "GTM",
"description": "Nationality of Guatemala",
"value": "Guatemalan"
},
{
"code": "GUF",
"description": "Nationality of French Guiana",
"value": "French Guiana"
},
{
"code": "GUM",
"description": "Nationality of Guam",
"value": "Guamanian"
},
{
"code": "GUY",
"description": "Nationality of Guyana",
"value": "Guyanese"
},
{
"code": "HKG",
"description": "Nationality of Hong Kong",
"value": "Hong Konger"
},
{
"code": "HMD",
"description": "Nationality of Heard and Mc Donald Islands",
"value": "Australian"
},
{
"code": "HND",
"description": "Nationality of Honduras",
"value": "Honduran"
},
{
"code": "HRV",
"description": "Nationality of Croatia (Hrvatska)",
"value": "Croatian"
},
{
"code": "HTI",
"description": "Nationality of Haiti",
"value": "Haitian"
},
{
"code": "HUN",
"description": "Nationality of Hungary",
"value": "Hungarian"
},
{
"code": "IDN",
"description": "Nationality of Indonesia",
"value": "Indonesian"
},
{
"code": "IMN",
"description": "Nationality of Isle of Man",
"value": "Manx"
},
{
"code": "IND",
"description": "Nationality of India",
"value": "Indian"
},
{
"code": "IOT",
"description": "Nationality of British Indian Ocean Territory",
"value": "British"
},
{
"code": "IRL",
"description": "Nationality of Ireland",
"value": "Irish "
},
{
"code": "IRN",
"description": "Nationality of Iran (Islamic Republic of)",
"value": "Iranian"
},
{
"code": "IRQ",
"description": "Nationality of Iraq",
"value": "Iraqi"
},
{
"code": "ISL",
"description": "Nationality of Iceland",
"value": "Icelander"
},
{
"code": "ISR",
"description": "Nationality of Israel",
"value": "Israeli"
},
{
"code": "ITA",
"description": "Nationality of Italy",
"value": "Italian"
},
{
"code": "JAM",
"description": "Nationality of Jamaica",
"value": "Jamaican"
},
{
"code": "JEY",
"description": "Nationality of Jersey",
"value": "Channel Islander"
},
{
"code": "JOR",
"description": "Nationality of Jordan",
"value": "Jordanian"
},
{
"code": "JPN",
"description": "Nationality of Japan",
"value": "Japanese"
},
{
"code": "KAZ",
"description": "Nationality of Kazakhstan",
"value": "Kazakh"
},
{
"code": "KEN",
"description": "Nationality of Kenya",
"value": "Kenyan"
},
{
"code": "KGZ",
"description": "Nationality of Kyrgyzstan",
"value": "Kyrgyzstani"
},
{
"code": "KHM",
"description": "Nationality of Cambodia",
"value": "Cambodian"
},
{
"code": "KIR",
"description": "Nationality of Kiribati",
"value": "I-Kiribati"
},
{
"code": "KNA",
"description": "Nationality of Saint Kitts and Nevis",
"value": "Kittitian, Nevisian"
},
{
"code": "KOR",
"description": "Nationality of Korea, Republic of",
"value": "South Korean"
},
{
"code": "KWT",
"description": "Nationality of Kuwait",
"value": "Kuwaiti"
},
{
"code": "LAO",
"description": "Nationality of Lao People's Democratic Republ",
"value": "Laotian"
},
{
"code": "LBN",
"description": "Nationality of Lebanon",
"value": "Lebanese"
},
{
"code": "LBR",
"description": "Nationality of Liberia",
"value": "Liberian"
},
{
"code": "LBY",
"description": "Nationality of Libyan Arab Jamahiriya",
"value": "Libyan"
},
{
"code": "LCA",
"description": "Nationality of Saint Lucia",
"value": "Saint Lucian"
},
{
"code": "LIE",
"description": "Nationality of Liechtenstein",
"value": "Liechtensteiner"
},
{
"code": "LKA",
"description": "Nationality of Sri Lanka",
"value": "Sri Lankan"
},
{
"code": "LSO",
"description": "Nationality of Lesotho",
"value": "Basotho"
},
{
"code": "LTU",
"description": "Nationality of Lithuania",
"value": "Lithuanian"
},
{
"code": "LUX",
"description": "Nationality of Luxembourg",
"value": "Luxembourger"
},
{
"code": "LVA",
"description": "Nationality of Latvia",
"value": "Latvian"
},
{
"code": "MAC",
"description": "Nationality of Macau",
"value": "Macau Chinese"
},
{
"code": "MAF",
"description": "Nationality of Saint Martin",
"value": "St. Maarten"
},
{
"code": "MAR",
"description": "Nationality of Morocco",
"value": "Moroccan"
},
{
"code": "MCO",
"description": "Nationality of Monaco",
"value": "Monacan"
},
{
"code": "MDA",
"description": "Nationality of Moldova, Republic of",
"value": "Moldovan"
},
{
"code": "MDG",
"description": "Nationality of Madagascar",
"value": "Madagascan"
},
{
"code": "MDV",
"description": "Nationality of Maldives",
"value": "Maldivian"
},
{
"code": "MEX",
"description": "Nationality of Mexico",
"value": "Mexican"
},
{
"code": "MHL",
"description": "Nationality of Marshall Islands",
"value": "Marshallese"
},
{
"code": "MKD",
"description": "Nationality of Macedonia",
"value": "Macedonian"
},
{
"code": "MLI",
"description": "Nationality of Mali",
"value": "Malian"
},
{
"code": "MLT",
"description": "Nationality of Malta",
"value": "Maltese"
},
{
"code": "MMR",
"description": "Nationality of Myanmar",
"value": "Burmese"
},
{
"code": "MNE",
"description": "Nationality of Montenegro",
"value": "Montenegrin"
},
{
"code": "MNG",
"description": "Nationality of Mongolia",
"value": "Mongolian"
},
{
"code": "MNP",
"description": "Nationality of Northern Mariana Islands",
"value": "American"
},
{
"code": "MOZ",
"description": "Nationality of Mozambique",
"value": "Mozambican"
},
{
"code": "MRT",
"description": "Nationality of Mauritania",
"value": "Mauritanian"
},
{
"code": "MSR",
"description": "Nationality of Montserrat",
"value": "Montserratian"
},
{
"code": "MTQ",
"description": "Nationality of Martinique",
"value": "Martiniquais"
},
{
"code": "MUS",
"description": "Nationality of Mauritius",
"value": "Mauritian"
},
{
"code": "MWI",
"description": "Nationality of Malawi",
"value": "Malawian"
},
{
"code": "MYS",
"description": "Nationality of Malaysia",
"value": "Malaysian"
},
{
"code": "MYT",
"description": "Nationality of Mayotte",
"value": "Mahorais"
},
{
"code": "NAM",
"description": "Nationality of Namibia",
"value": "Namibian"
},
{
"code": "NCL",
"description": "Nationality of New Caledonia",
"value": "New Caledonian"
},
{
"code": "NER",
"description": "Nationality of Niger",
"value": "Nigerien"
},
{
"code": "NFK",
"description": "Nationality of Norfolk Island",
"value": "Norfolk Islander"
},
{
"code": "NGA",
"description": "Nationality of Nigeria",
"value": "Nigerian"
},
{
"code": "NIC",
"description": "Nationality of Nicaragua",
"value": "Nicaraguan"
},
{
"code": "NIU",
"description": "Nationality of Niue",
"value": "Niuean"
},
{
"code": "NLD",
"description": "Nationality of Netherlands",
"value": "Dutch"
},
{
"code": "NOR",
"description": "Nationality of Norway",
"value": "Norwegian"
},
{
"code": "NPL",
"description": "Nationality of Nepal",
"value": "Nepalese"
},
{
"code": "NRU",
"description": "Nationality of Nauru",
"value": "Nauruan"
},
{
"code": "NZL",
"description": "Nationality of New Zealand",
"value": "New Zealander"
},
{
"code": "OMN",
"description": "Nationality of Oman",
"value": "Omani"
},
{
"code": "PAK",
"description": "Nationality of Pakistan",
"value": "Pakistani"
},
{
"code": "PAN",
"description": "Nationality of Panama",
"value": "Panamanian"
},
{
"code": "PCN",
"description": "Nationality of Pitcairn",
"value": "Pitcairn Islander"
},
{
"code": "PER",
"description": "Nationality of Peru",
"value": "Peruvian"
},
{
"code": "PHL",
"description": "Nationality of Philippines",
"value": "Filipino"
},
{
"code": "PLW",
"description": "Nationality of Palau",
"value": "Palauan"
},
{
"code": "PNG",
"description": "Nationality of Papua New Guinea",
"value": "Papua New Guinean"
},
{
"code": "POL",
"description": "Nationality of Poland",
"value": "Pole"
},
{
"code": "PRI",
"description": "Nationality of Puerto Rico",
"value": "Puerto Rican"
},
{
"code": "PRK",
"description": "Nationality of Korea, Democratic People's Rep",
"value": "North Korean"
},
{
"code": "PRT",
"description": "Nationality of Portugal",
"value": "Portuguese"
},
{
"code": "PRY",
"description": "Nationality of Paraguay",
"value": "Paraguayan"
},
{
"code": "PSE",
"description": "Nationality of Palestine",
"value": "Palestinian"
},
{
"code": "PYF",
"description": "Nationality of French Polynesia",
"value": "French Polynesian"
},
{
"code": "QAT",
"description": "Nationality of Qatar",
"value": "Qatari"
},
{
"code": "REU",
"description": "Nationality of Reunion",
"value": "Reunionese"
},
{
"code": "ROU",
"description": "Nationality of Romania",
"value": "Romanian"
},
{
"code": "RUS",
"description": "Nationality of Russian Federation",
"value": "Russian"
},
{
"code": "RWA",
"description": "Nationality of Rwanda",
"value": "Rwandan"
},
{
"code": "SAU",
"description": "Nationality of Saudi Arabia",
"value": "Saudi Arabian"
},
{
"code": "SDN",
"description": "Nationality of Sudan",
"value": "Sudanese"
},
{
"code": "SEN",
"description": "Nationality of Senegal",
"value": "Senegalese"
},
{
"code": "SGP",
"description": "Nationality of Singapore",
"value": "Singaporean"
},
{
"code": "SGS",
"description": "Nationality of South Georgia South Sandwich Islands",
"value": "South Georgian South Sandwich Islander"
},
{
"code": "SHN",
"description": "Nationality of St. Helena",
"value": "Saint Helenians"
},
{
"code": "SJM",
"description": "Nationality of Svalbard and Jan Mayen Islands",
"value": "Svalbard"
},
{
"code": "SLB",
"description": "Nationality of Solomon Islands",
"value": "Solomon Islander"
},
{
"code": "SLE",
"description": "Nationality of Sierra Leone",
"value": "Sierra Leonian"
},
{
"code": "SLV",
"description": "Nationality of El Salvador",
"value": "Salvadorean"
},
{
"code": "SMR",
"description": "Nationality of San Marino",
"value": "Sammarinese"
},
{
"code": "SOM",
"description": "Nationality of Somalia",
"value": "Somali"
},
{
"code": "SPM",
"description": "Nationality of St. Pierre and Miquelon",
"value": "French"
},
{
"code": "SRB",
"description": "Nationality of Serbia",
"value": "Serbian"
},
{
"code": "SSD",
"description": "Nationality of South Sudan",
"value": "South Sudanese"
},
{
"code": "STP",
"description": "Nationality of Sao Tome and Principe",
"value": "Sao Tomean"
},
{
"code": "SUR",
"description": "Nationality of Suriname",
"value": "Surinamese"
},
{
"code": "SVK",
"description": "Nationality of Slovakia",
"value": "Slovak"
},
{
"code": "SVN",
"description": "Nationality of Slovenia",
"value": "Slovenian"
},
{
"code": "SWE",
"description": "Nationality of Sweden",
"value": "Swede"
},
{
"code": "SWZ",
"description": "Nationality of Swaziland",
"value": "Swazi"
},
{
"code": "SYC",
"description": "Nationality of Seychelles",
"value": "Seychellois"
},
{
"code": "SYR",
"description": "Nationality of Syrian Arab Republic",
"value": "Syrian"
},
{
"code": "TCA",
"description": "Nationality of Turks and Caicos Islands",
"value": "Turks and Caicos Islander"
},
{
"code": "TCD",
"description": "Nationality of Chad",
"value": "Chadian"
},
{
"code": "TGO",
"description": "Nationality of Togo",
"value": "Togolese"
},
{
"code": "THA",
"description": "Nationality of Thailand",
"value": "Thai"
},
{
"code": "TJK",
"description": "Nationality of Tajikistan",
"value": "Tadjik"
},
{
"code": "TKL",
"description": "Nationality of Tokelau",
"value": "Tokelauan"
},
{
"code": "TKM",
"description": "Nationality of Turkmenistan",
"value": "Turkmen"
},
{
"code": "TLS",
"description": "Nationality of Timor-Leste",
"value": "Timorese"
},
{
"code": "TMP",
"description": "Nationality of East Timor",
"value": "Timorese"
},
{
"code": "TON",
"description": "Nationality of Tonga",
"value": "Tongan"
},
{
"code": "TTO",
"description": "Nationality of Trinidad and Tobago",
"value": "Trinidadian"
},
{
"code": "TUN",
"description": "Nationality of Tunisia",
"value": "Tunisian"
},
{
"code": "TUR",
"description": "Nationality of Turkey",
"value": "Turk"
},
{
"code": "TUV",
"description": "Nationality of Tuvalu",
"value": "Tuvaluan"
},
{
"code": "TWN",
"description": "Nationality of Taiwan",
"value": "Taiwanese"
},
{
"code": "TZA",
"description": "Nationality of Tanzania, United Republic of",
"value": "Tanzanian"
},
{
"code": "UGA",
"description": "Nationality of Uganda",
"value": "Ugandan"
},
{
"code": "UKR",
"description": "Nationality of Ukraine",
"value": "Ukrainian"
},
{
"code": "UMI",
"description": "Nationality of United States minor outlying islands",
"value": "American"
},
{
"code": "UNK",
"description": "Nationality of Kosovo",
"value": "Kosovan"
},
{
"code": "URY",
"description": "Nationality of Uruguay",
"value": "Uruguayan"
},
{
"code": "USA",
"description": "Nationality of United States",
"value": "American"
},
{
"code": "UZB",
"description": "Nationality of Uzbekistan",
"value": "Uzbek"
},
{
"code": "VAT",
"description": "Nationality of Vatican City State",
"value": "Vatican"
},
{
"code": "VCT",
"description": "Nationality of Saint Vincent and the Grenadin",
"value": "Vincentian"
},
{
"code": "VEN",
"description": "Nationality of Venezuela",
"value": "Venezuelan"
},
{
"code": "VGB",
"description": "Nationality of Virgin Islands (British)",
"value": "British Virgin Islander"
},
{
"code": "VIR",
"description": "Nationality of Virgin Islands (U.S.)",
"value": "Virgin Islander"
},
{
"code": "VNM",
"description": "Nationality of Vietnam",
"value": "Vietnamese"
},
{
"code": "VUT",
"description": "Nationality of Vanuatu",
"value": "Ni-Vanuatu"
},
{
"code": "WLF",
"description": "Nationality of Wallis and Futuna Islands",
"value": "Wallis and Futuna Islander"
},
{
"code": "WSM",
"description": "Nationality of Samoa",
"value": "Samoan"
},
{
"code": "YEM",
"description": "Nationality of Yemen",
"value": "Yemeni"
},
{
"code": "ZAF",
"description": "Nationality of South Africa",
"value": "South African"
},
{
"code": "ZMB",
"description": "Nationality of Zambia",
"value": "Zambian"
},
{
"code": "ZRE",
"description": "Nationality of Zaire",
"value": "Zairian"
},
{
"code": "ZWE",
"description": "Nationality of Zimbabwe",
"value": "Zimbabwean"
}
],
"field_category": "Address Details"
}
]
},
{
"field_group_key": "identification_details",
"field_group_label": "Identification details",
"fields": [
{
"field_key": "identity_type",
"field_label": "Identification Type",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"enum_key": "id_types",
"values_supported": [
{
"code": "NRIC",
"description": "NRIC",
"value": "NRIC"
},
{
"code": "VOTERS_ID",
"description": "Voter's photo ID card",
"value": "Voter's photo ID card"
},
{
"code": "DRIVERS_ID",
"description": "Driver's license",
"value": "Driver's license"
},
{
"code": "PASSPORT",
"description": "Valid passport",
"value": "Valid passport"
},
{
"code": "PAN",
"description": "PAN Card",
"value": "PAN Card"
},
{
"code": "RATION",
"description": "Family ration card",
"value": "Family ration card"
},
{
"code": "U_BILL",
"description": "Utility bill",
"value": "Utility bill"
},
{
"code": "S_LICENSE",
"description": "Shop license",
"value": "Shop license"
},
{
"code": "LOI",
"description": "Letter of introduction",
"value": "Letter of introduction"
},
{
"code": "AADHAAR",
"description": "Aadhaar",
"value": "Aadhaar"
},
{
"code": "EPFIN",
"description": "EP FIN No.",
"value": "EP FIN No."
},
{
"code": "SPASS",
"description": "S PASS No.",
"value": "S PASS No."
},
{
"code": "WP",
"description": "Work permit",
"value": "Work permit"
},
{
"code": "CMND",
"description": "Chứng minh nhân dân",
"value": "Chứng minh nhân dân"
},
{
"code": "MILITARY_ID",
"description": "Military Id",
"value": "Military Id"
},
{
"code": "MEDICARE_CARD",
"description": "Medicare Card",
"value": "Medicare Card"
}
],
"field_category": "Identification Details"
},
{
"field_key": "identity_number",
"field_label": "Identification Number",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 0,
"regex": "^[#.0-9a-zA-Z\\s,-_)(']+$"
},
"field_category": "Identification Details"
},
{
"field_key": "country_of_issue",
"field_label": "Country of Issue",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 0,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "Identification Details"
},
{
"field_key": "issue_date",
"field_label": "Issue Date",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 0,
"regex": "^([0-9]{4})-([0-9]{2})-([0-9]{2})$"
},
"field_category": "Identification Details"
},
{
"field_key": "expiry_date",
"field_label": "Expiry Date",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 0,
"regex": "^([0-9]{4})-([0-9]{2})-([0-9]{2})$"
},
"field_category": "Identification Details"
},
{
"field_key": "date_of_incorporation",
"field_label": "Date of Incorporation",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 0,
"regex": "^([0-9]{4})-([0-9]{2})-([0-9]{2})$"
},
"field_category": "Identification Details"
}
]
},
{
"field_group_key": "user_information",
"field_group_label": "User Information",
"fields": [
{
"field_key": "first_name",
"field_label": "First Name",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "User Information"
},
{
"field_key": "middle_name",
"field_label": "Middle Name",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 0,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "User Information"
},
{
"field_key": "last_name",
"field_label": "Last Name",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 50,
"min_length": 1,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "User Information"
},
{
"field_key": "preferred_name",
"field_label": "Preferred Name",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 100,
"min_length": 0,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "User Information"
},
{
"field_key": "gender",
"field_label": "Gender",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"values_supported": [
{
"code": "MALE",
"description": "Male",
"value": "Male"
},
{
"code": "FEMALE",
"description": "Female",
"value": "Female"
}
],
"field_category": "User Information"
},
{
"field_key": "date_of_birth",
"field_label": "Date of Birth",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"validation": {
"max_length": 100,
"min_length": 0,
"regex": "^([0-9]{4})-([0-9]{2})-([0-9]{2})$"
},
"field_category": "User Information"
},
{
"field_key": "email",
"field_label": "Email",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 100,
"min_length": 5,
"regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
},
"field_category": "User Information"
},
{
"field_key": "mobile_country_code",
"field_label": "Mobile Country code",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"values_supported": [
{
"code": "43",
"description": "Austria",
"value": "Austria"
},
{
"code": "376",
"description": "Andorra",
"value": "Andorra"
},
{
"code": "971",
"description": "United Arab Emirates",
"value": "United Arab Emirates"
},
{
"code": "93",
"description": "Afghanistan",
"value": "Afghanistan"
},
{
"code": "1 268",
"description": "Antigua And Barbuda",
"value": "Antigua And Barbuda"
},
{
"code": "1 264",
"description": "Anguilla",
"value": "Anguilla"
},
{
"code": "355",
"description": "Albania",
"value": "Albania"
},
{
"code": "374",
"description": "Armenia",
"value": "Armenia"
},
{
"code": "244",
"description": "Angola",
"value": "Angola"
},
{
"code": "672",
"description": "Antarctica",
"value": "Antarctica"
},
{
"code": "54",
"description": "Argentina",
"value": "Argentina"
},
{
"code": "1 684",
"description": "American Samoa",
"value": "American Samoa"
},
{
"code": "61",
"description": "Australia",
"value": "Australia"
},
{
"code": "297",
"description": "Aruba",
"value": "Aruba"
},
{
"code": "358",
"description": "Åland Islands",
"value": "Åland Islands"
},
{
"code": "994",
"description": "Azerbaijan",
"value": "Azerbaijan"
},
{
"code": "387",
"description": "Bosnia & Herzegovina",
"value": "Bosnia & Herzegovina"
},
{
"code": "1 246",
"description": "Barbados",
"value": "Barbados"
},
{
"code": "880",
"description": "Bangladesh",
"value": "Bangladesh"
},
{
"code": "32",
"description": "Belgium",
"value": "Belgium"
},
{
"code": "226",
"description": "Burkina Faso",
"value": "Burkina Faso"
},
{
"code": "359",
"description": "Bulgaria",
"value": "Bulgaria"
},
{
"code": "973",
"description": "Bahrain",
"value": "Bahrain"
},
{
"code": "257",
"description": "Burundi",
"value": "Burundi"
},
{
"code": "229",
"description": "Benin",
"value": "Benin"
},
{
"code": "590",
"description": "Saint Barthélemy",
"value": "Saint Barthélemy"
},
{
"code": "1 441",
"description": "Bermuda",
"value": "Bermuda"
},
{
"code": "673",
"description": "Brunei Darussalam",
"value": "Brunei Darussalam"
},
{
"code": "591",
"description": "Bolivia, Plurinational State Of",
"value": "Bolivia, Plurinational State Of"
},
{
"code": "55",
"description": "Brazil",
"value": "Brazil"
},
{
"code": "1 242",
"description": "Bahamas",
"value": "Bahamas"
},
{
"code": "975",
"description": "Bhutan",
"value": "Bhutan"
},
{
"code": "47",
"description": "Bouvet Island",
"value": "Bouvet Island"
},
{
"code": "267",
"description": "Botswana",
"value": "Botswana"
},
{
"code": "375",
"description": "Belarus",
"value": "Belarus"
},
{
"code": "501",
"description": "Belize",
"value": "Belize"
},
{
"code": "1",
"description": "Canada",
"value": "Canada"
},
{
"code": "61",
"description": "Cocos (Keeling) Islands",
"value": "Cocos (Keeling) Islands"
},
{
"code": "243",
"description": "Democratic Republic Of Congo",
"value": "Democratic Republic Of Congo"
},
{
"code": "236",
"description": "Central African Republic",
"value": "Central African Republic"
},
{
"code": "242",
"description": "Republic Of Congo",
"value": "Republic Of Congo"
},
{
"code": "41",
"description": "Switzerland",
"value": "Switzerland"
},
{
"code": "225",
"description": "Cote d'Ivoire",
"value": "Cote d'Ivoire"
},
{
"code": "682",
"description": "Cook Islands",
"value": "Cook Islands"
},
{
"code": "56",
"description": "Chile",
"value": "Chile"
},
{
"code": "237",
"description": "Cameroon",
"value": "Cameroon"
},
{
"code": "86",
"description": "China",
"value": "China"
},
{
"code": "57",
"description": "Colombia",
"value": "Colombia"
},
{
"code": "506",
"description": "Costa Rica",
"value": "Costa Rica"
},
{
"code": "53",
"description": "Cuba",
"value": "Cuba"
},
{
"code": "238",
"description": "Cabo Verde",
"value": "Cabo Verde"
},
{
"code": "61",
"description": "Christmas Island",
"value": "Christmas Island"
},
{
"code": "357",
"description": "Cyprus",
"value": "Cyprus"
},
{
"code": "420",
"description": "Czech Republic",
"value": "Czech Republic"
},
{
"code": "49",
"description": "Germany",
"value": "Germany"
},
{
"code": "253",
"description": "Djibouti",
"value": "Djibouti"
},
{
"code": "45",
"description": "Denmark",
"value": "Denmark"
},
{
"code": "1 767",
"description": "Dominica",
"value": "Dominica"
},
{
"code": "1 809",
"description": "Dominican Republic",
"value": "Dominican Republic"
},
{
"code": "213",
"description": "Algeria",
"value": "Algeria"
},
{
"code": "593",
"description": "Ecuador",
"value": "Ecuador"
},
{
"code": "372",
"description": "Estonia",
"value": "Estonia"
},
{
"code": "20",
"description": "Egypt",
"value": "Egypt"
},
{
"code": "212",
"description": "Western Sahara",
"value": "Western Sahara"
},
{
"code": "291",
"description": "Eritrea",
"value": "Eritrea"
},
{
"code": "34",
"description": "Spain",
"value": "Spain"
},
{
"code": "251",
"description": "Ethiopia",
"value": "Ethiopia"
},
{
"code": "358",
"description": "Finland",
"value": "Finland"
},
{
"code": "679",
"description": "Fiji",
"value": "Fiji"
},
{
"code": "500",
"description": "Falkland Islands",
"value": "Falkland Islands"
},
{
"code": "691",
"description": "Micronesia, Federated States Of",
"value": "Micronesia, Federated States Of"
},
{
"code": "298",
"description": "Faroe Islands",
"value": "Faroe Islands"
},
{
"code": "33",
"description": "France",
"value": "France"
},
{
"code": "33",
"description": "France, Metropolitan",
"value": "France, Metropolitan"
},
{
"code": "241",
"description": "Gabon",
"value": "Gabon"
},
{
"code": "44",
"description": "United Kingdom",
"value": "United Kingdom"
},
{
"code": "473",
"description": "Grenada",
"value": "Grenada"
},
{
"code": "995",
"description": "Georgia",
"value": "Georgia"
},
{
"code": "594",
"description": "French Guiana",
"value": "French Guiana"
},
{
"code": "44",
"description": "Guernsey",
"value": "Guernsey"
},
{
"code": "233",
"description": "Ghana",
"value": "Ghana"
},
{
"code": "350",
"description": "Gibraltar",
"value": "Gibraltar"
},
{
"code": "299",
"description": "Greenland",
"value": "Greenland"
},
{
"code": "220",
"description": "Gambia",
"value": "Gambia"
},
{
"code": "224",
"description": "Guinea",
"value": "Guinea"
},
{
"code": "590",
"description": "Guadeloupe",
"value": "Guadeloupe"
},
{
"code": "240",
"description": "Equatorial Guinea",
"value": "Equatorial Guinea"
},
{
"code": "30",
"description": "Greece",
"value": "Greece"
},
{
"code": "500",
"description": "South Georgia And The South Sandwich Islands",
"value": "South Georgia And The South Sandwich Islands"
},
{
"code": "502",
"description": "Guatemala",
"value": "Guatemala"
},
{
"code": "1 671",
"description": "Guam",
"value": "Guam"
},
{
"code": "245",
"description": "Guinea-bissau",
"value": "Guinea-bissau"
},
{
"code": "592",
"description": "Guyana",
"value": "Guyana"
},
{
"code": "852",
"description": "Hong Kong",
"value": "Hong Kong"
},
{
"code": "672",
"description": "Heard Island And McDonald Islands",
"value": "Heard Island And McDonald Islands"
},
{
"code": "504",
"description": "Honduras",
"value": "Honduras"
},
{
"code": "385",
"description": "Croatia",
"value": "Croatia"
},
{
"code": "509",
"description": "Haiti",
"value": "Haiti"
},
{
"code": "36",
"description": "Hungary",
"value": "Hungary"
},
{
"code": "62",
"description": "Indonesia",
"value": "Indonesia"
},
{
"code": "353",
"description": "Ireland",
"value": "Ireland"
},
{
"code": "972",
"description": "Israel",
"value": "Israel"
},
{
"code": "44",
"description": "Isle Of Man",
"value": "Isle Of Man"
},
{
"code": "91",
"description": "India",
"value": "India"
},
{
"code": "246",
"description": "British Indian Ocean Territory",
"value": "British Indian Ocean Territory"
},
{
"code": "964",
"description": "Iraq",
"value": "Iraq"
},
{
"code": "98",
"description": "Iran, Islamic Republic Of",
"value": "Iran, Islamic Republic Of"
},
{
"code": "354",
"description": "Iceland",
"value": "Iceland"
},
{
"code": "39",
"description": "Italy",
"value": "Italy"
},
{
"code": "44",
"description": "Jersey",
"value": "Jersey"
},
{
"code": "1 876",
"description": "Jamaica",
"value": "Jamaica"
},
{
"code": "962",
"description": "Jordan",
"value": "Jordan"
},
{
"code": "81",
"description": "Japan",
"value": "Japan"
},
{
"code": "254",
"description": "Kenya",
"value": "Kenya"
},
{
"code": "996",
"description": "Kyrgyzstan",
"value": "Kyrgyzstan"
},
{
"code": "855",
"description": "Cambodia",
"value": "Cambodia"
},
{
"code": "686",
"description": "Kiribati",
"value": "Kiribati"
},
{
"code": "269",
"description": "Comoros",
"value": "Comoros"
},
{
"code": "1 869",
"description": "Saint Kitts And Nevis",
"value": "Saint Kitts And Nevis"
},
{
"code": "850",
"description": "Korea, Democratic People's Republic Of",
"value": "Korea, Democratic People's Republic Of"
},
{
"code": "82",
"description": "Korea, Republic Of",
"value": "Korea, Republic Of"
},
{
"code": "965",
"description": "Kuwait",
"value": "Kuwait"
},
{
"code": "1 345",
"description": "Cayman Islands",
"value": "Cayman Islands"
},
{
"code": "7",
"description": "Kazakhstan",
"value": "Kazakhstan"
},
{
"code": "856",
"description": "Lao People's Democratic Republic",
"value": "Lao People's Democratic Republic"
},
{
"code": "961",
"description": "Lebanon",
"value": "Lebanon"
},
{
"code": "1 758",
"description": "Saint Lucia",
"value": "Saint Lucia"
},
{
"code": "423",
"description": "Liechtenstein",
"value": "Liechtenstein"
},
{
"code": "94",
"description": "Sri Lanka",
"value": "Sri Lanka"
},
{
"code": "231",
"description": "Liberia",
"value": "Liberia"
},
{
"code": "266",
"description": "Lesotho",
"value": "Lesotho"
},
{
"code": "370",
"description": "Lithuania",
"value": "Lithuania"
},
{
"code": "352",
"description": "Luxembourg",
"value": "Luxembourg"
},
{
"code": "371",
"description": "Latvia",
"value": "Latvia"
},
{
"code": "218",
"description": "Libya",
"value": "Libya"
},
{
"code": "212",
"description": "Morocco",
"value": "Morocco"
},
{
"code": "377",
"description": "Monaco",
"value": "Monaco"
},
{
"code": "373",
"description": "Moldova",
"value": "Moldova"
},
{
"code": "382",
"description": "Montenegro",
"value": "Montenegro"
},
{
"code": "590",
"description": "Saint Martin",
"value": "Saint Martin"
},
{
"code": "261",
"description": "Madagascar",
"value": "Madagascar"
},
{
"code": "692",
"description": "Marshall Islands",
"value": "Marshall Islands"
},
{
"code": "389",
"description": "Macedonia, The Former Yugoslav Republic Of",
"value": "Macedonia, The Former Yugoslav Republic Of"
},
{
"code": "223",
"description": "Mali",
"value": "Mali"
},
{
"code": "95",
"description": "Myanmar",
"value": "Myanmar"
},
{
"code": "976",
"description": "Mongolia",
"value": "Mongolia"
},
{
"code": "853",
"description": "Macao",
"value": "Macao"
},
{
"code": "1 670",
"description": "Northern Mariana Islands",
"value": "Northern Mariana Islands"
},
{
"code": "596",
"description": "Martinique",
"value": "Martinique"
},
{
"code": "222",
"description": "Mauritania",
"value": "Mauritania"
},
{
"code": "1 664",
"description": "Montserrat",
"value": "Montserrat"
},
{
"code": "356",
"description": "Malta",
"value": "Malta"
},
{
"code": "230",
"description": "Mauritius",
"value": "Mauritius"
},
{
"code": "960",
"description": "Maldives",
"value": "Maldives"
},
{
"code": "265",
"description": "Malawi",
"value": "Malawi"
},
{
"code": "52",
"description": "Mexico",
"value": "Mexico"
},
{
"code": "60",
"description": "Malaysia",
"value": "Malaysia"
},
{
"code": "258",
"description": "Mozambique",
"value": "Mozambique"
},
{
"code": "264",
"description": "Namibia",
"value": "Namibia"
},
{
"code": "687",
"description": "New Caledonia",
"value": "New Caledonia"
},
{
"code": "227",
"description": "Niger",
"value": "Niger"
},
{
"code": "672",
"description": "Norfolk Island",
"value": "Norfolk Island"
},
{
"code": "234",
"description": "Nigeria",
"value": "Nigeria"
},
{
"code": "505",
"description": "Nicaragua",
"value": "Nicaragua"
},
{
"code": "31",
"description": "Netherlands",
"value": "Netherlands"
},
{
"code": "47",
"description": "Norway",
"value": "Norway"
},
{
"code": "977",
"description": "Nepal",
"value": "Nepal"
},
{
"code": "674",
"description": "Nauru",
"value": "Nauru"
},
{
"code": "683",
"description": "Niue",
"value": "Niue"
},
{
"code": "64",
"description": "New Zealand",
"value": "New Zealand"
},
{
"code": "968",
"description": "Oman",
"value": "Oman"
},
{
"code": "507",
"description": "Panama",
"value": "Panama"
},
{
"code": "51",
"description": "Peru",
"value": "Peru"
},
{
"code": "689",
"description": "French Polynesia",
"value": "French Polynesia"
},
{
"code": "675",
"description": "Papua New Guinea",
"value": "Papua New Guinea"
},
{
"code": "63",
"description": "Philippines",
"value": "Philippines"
},
{
"code": "92",
"description": "Pakistan",
"value": "Pakistan"
},
{
"code": "48",
"description": "Poland",
"value": "Poland"
},
{
"code": "508",
"description": "Saint Pierre And Miquelon",
"value": "Saint Pierre And Miquelon"
},
{
"code": "872",
"description": "Pitcairn",
"value": "Pitcairn"
},
{
"code": "1 787",
"description": "Puerto Rico",
"value": "Puerto Rico"
},
{
"code": "970",
"description": "Palestinian Territory, Occupied",
"value": "Palestinian Territory, Occupied"
},
{
"code": "351",
"description": "Portugal",
"value": "Portugal"
},
{
"code": "680",
"description": "Palau",
"value": "Palau"
},
{
"code": "595",
"description": "Paraguay",
"value": "Paraguay"
},
{
"code": "974",
"description": "Qatar",
"value": "Qatar"
},
{
"code": "262",
"description": "Reunion",
"value": "Reunion"
},
{
"code": "40",
"description": "Romania",
"value": "Romania"
},
{
"code": "381",
"description": "Serbia",
"value": "Serbia"
},
{
"code": "7",
"description": "Russian Federation",
"value": "Russian Federation"
},
{
"code": "250",
"description": "Rwanda",
"value": "Rwanda"
},
{
"code": "966",
"description": "Saudi Arabia",
"value": "Saudi Arabia"
},
{
"code": "677",
"description": "Solomon Islands",
"value": "Solomon Islands"
},
{
"code": "248",
"description": "Seychelles",
"value": "Seychelles"
},
{
"code": "249",
"description": "Sudan",
"value": "Sudan"
},
{
"code": "46",
"description": "Sweden",
"value": "Sweden"
},
{
"code": "65",
"description": "Singapore",
"value": "Singapore"
},
{
"code": "290",
"description": "Saint Helena, Ascension And Tristan Da Cunha",
"value": "Saint Helena, Ascension And Tristan Da Cunha"
},
{
"code": "386",
"description": "Slovenia",
"value": "Slovenia"
},
{
"code": "47",
"description": "Svalbard And Jan Mayen",
"value": "Svalbard And Jan Mayen"
},
{
"code": "421",
"description": "Slovakia",
"value": "Slovakia"
},
{
"code": "232",
"description": "Sierra Leone",
"value": "Sierra Leone"
},
{
"code": "378",
"description": "San Marino",
"value": "San Marino"
},
{
"code": "221",
"description": "Senegal",
"value": "Senegal"
},
{
"code": "252",
"description": "Somalia",
"value": "Somalia"
},
{
"code": "597",
"description": "Suriname",
"value": "Suriname"
},
{
"code": "211",
"description": "South Sudan",
"value": "South Sudan"
},
{
"code": "239",
"description": "São Tomé and Príncipe",
"value": "São Tomé and Príncipe"
},
{
"code": "503",
"description": "El Salvador",
"value": "El Salvador"
},
{
"code": "963",
"description": "Syrian Arab Republic",
"value": "Syrian Arab Republic"
},
{
"code": "268",
"description": "Swaziland",
"value": "Swaziland"
},
{
"code": "1 649",
"description": "Turks And Caicos Islands",
"value": "Turks And Caicos Islands"
},
{
"code": "235",
"description": "Chad",
"value": "Chad"
},
{
"code": "262",
"description": "French Southern Territories",
"value": "French Southern Territories"
},
{
"code": "228",
"description": "Togo",
"value": "Togo"
},
{
"code": "66",
"description": "Thailand",
"value": "Thailand"
},
{
"code": "992",
"description": "Tajikistan",
"value": "Tajikistan"
},
{
"code": "690",
"description": "Tokelau",
"value": "Tokelau"
},
{
"code": "670",
"description": "East Timor",
"value": "East Timor"
},
{
"code": "993",
"description": "Turkmenistan",
"value": "Turkmenistan"
},
{
"code": "216",
"description": "Tunisia",
"value": "Tunisia"
},
{
"code": "676",
"description": "Tonga",
"value": "Tonga"
},
{
"code": "90",
"description": "Turkey",
"value": "Turkey"
},
{
"code": "1 868",
"description": "Trinidad And Tobago",
"value": "Trinidad And Tobago"
},
{
"code": "688",
"description": "Tuvalu",
"value": "Tuvalu"
},
{
"code": "886",
"description": "Taiwan, Province Of China",
"value": "Taiwan, Province Of China"
},
{
"code": "255",
"description": "Tanzania, United Republic Of",
"value": "Tanzania, United Republic Of"
},
{
"code": "380",
"description": "Ukraine",
"value": "Ukraine"
},
{
"code": "256",
"description": "Uganda",
"value": "Uganda"
},
{
"code": "1",
"description": "United States Minor Outlying Islands",
"value": "United States Minor Outlying Islands"
},
{
"code": "1",
"description": "United States",
"value": "United States"
},
{
"code": "598",
"description": "Uruguay",
"value": "Uruguay"
},
{
"code": "998",
"description": "Uzbekistan",
"value": "Uzbekistan"
},
{
"code": "379",
"description": "Vatican City State",
"value": "Vatican City State"
},
{
"code": "1 784",
"description": "Saint Vincent And The Grenadines",
"value": "Saint Vincent And The Grenadines"
},
{
"code": "58",
"description": "Venezuela, Bolivarian Republic Of",
"value": "Venezuela, Bolivarian Republic Of"
},
{
"code": "1 284",
"description": "Virgin Islands (British)",
"value": "Virgin Islands (British)"
},
{
"code": "1 340",
"description": "Virgin Islands (US)",
"value": "Virgin Islands (US)"
},
{
"code": "84",
"description": "Vietnam",
"value": "Vietnam"
},
{
"code": "678",
"description": "Vanuatu",
"value": "Vanuatu"
},
{
"code": "681",
"description": "Wallis And Futuna",
"value": "Wallis And Futuna"
},
{
"code": "685",
"description": "Samoa",
"value": "Samoa"
},
{
"code": "967",
"description": "Yemen",
"value": "Yemen"
},
{
"code": "262",
"description": "Mayotte",
"value": "Mayotte"
},
{
"code": "27",
"description": "South Africa",
"value": "South Africa"
},
{
"code": "260",
"description": "Zambia",
"value": "Zambia"
},
{
"code": "263",
"description": "Zimbabwe",
"value": "Zimbabwe"
}
],
"field_category": "User Information"
},
{
"field_key": "mobile",
"field_label": "Mobile Number",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"validation": {
"max_length": 31,
"min_length": 1
},
"field_category": "User Information"
},
{
"field_key": "occupation",
"field_label": "Occupation",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"enum_key": "occupations",
"values_supported": [
{
"code": "GENERAL_WORKER",
"description": "General Worker",
"value": "General Worker"
},
{
"code": "BUSINESSMAN",
"description": "Businessman",
"value": "Businessman"
},
{
"code": "PROFESSIONAL",
"description": "Professional",
"value": "Professional"
},
{
"code": "SUPERVISOR",
"description": "Supervisor",
"value": "Supervisor"
},
{
"code": "TOURIST",
"description": "Tourist",
"value": "Tourist"
},
{
"code": "SECURITY_GUARD",
"description": "Security Guard",
"value": "Security Guard"
},
{
"code": "HOUSE_MAID",
"description": "House Maid",
"value": "House Maid"
},
{
"code": "DOMESTIC_HELPER",
"description": "Domestic Helper",
"value": "Domestic Helper"
},
{
"code": "HOUSE_WIFE",
"description": "House Wife",
"value": "House Wife"
},
{
"code": "OTHERS",
"description": "Others",
"value": "Others"
}
],
"field_category": "User Information"
}
]
},
{
"field_group_key": "additional_data",
"field_group_label": "Additional Data",
"fields": [
{
"field_key": "purpose_of_payment",
"field_label": "Purpose of Payment",
"field_type": "string",
"is_mandatory": true,
"is_editable": true,
"enum_key": "purpose_of_payment",
"values_supported": [
{
"code": "FAMILY_MAINTENANCE",
"description": "Family Maintenance",
"value": "Family Maintenance"
},
{
"code": "HOUSEHOLD_MAINTENANCE",
"description": "Household Maintenance",
"value": "Household Maintenance"
},
{
"code": "DONATION_OR_GIFTS",
"description": "Donation or Gifts",
"value": "Donation or Gifts"
},
{
"code": "PAYMENT_OF_LOAN",
"description": "Payment of Loan",
"value": "Payment of Loan"
},
{
"code": "PURCHASE_OF_PROPERTY",
"description": "Purchase of Property",
"value": "Purchase of Property"
},
{
"code": "FUNERAL_EXPENSES",
"description": "Funeral Expenses",
"value": "Funeral Expenses"
},
{
"code": "WEDDING_EXPENSES",
"description": "Wedding Expenses",
"value": "Wedding Expenses"
},
{
"code": "MEDICAL_EXPENSES",
"description": "Medical Expenses",
"value": "Medical Expenses"
},
{
"code": "PAYMENT_OF_BILLS",
"description": "Payment of bills",
"value": "Payment of bills"
},
{
"code": "EDUCATION",
"description": "Education",
"value": "Education"
},
{
"code": "SAVINGS",
"description": "Savings",
"value": "Savings"
},
{
"code": "EMPLOYEE_COLLEAGUE",
"description": "Employee Colleague",
"value": "Employee Colleague"
},
{
"code": "BUSINESS_OR_INVESTMENT",
"description": "Business or Investment",
"value": "Business or Investment"
},
{
"code": "SALARY",
"description": "Salary",
"value": "Salary"
},
{
"code": "PAYMENT_OF_GOODS_AND_SERVICES",
"description": "Payment of goods and services",
"value": "Payment of goods and services"
}
],
"field_category": "Additional Data"
},
{
"field_key": "user_recipient_relationship",
"field_label": "User Relationship with Recipient",
"field_type": "string",
"is_mandatory": false,
"is_editable": true,
"enum_key": "user_recipient_relationship",
"values_supported": [
{
"code": "FATHER",
"description": "Father",
"value": "Father"
},
{
"code": "MOTHER",
"description": "Mother",
"value": "Mother"
},
{
"code": "DAUGHTER",
"description": "Daughter",
"value": "Daughter"
},
{
"code": "SON",
"description": "Son",
"value": "Son"
},
{
"code": "SISTER",
"description": "Sister",
"value": "Sister"
},
{
"code": "BROTHER",
"description": "Brother",
"value": "Brother"
},
{
"code": "WIFE",
"description": "Wife",
"value": "Wife"
},
{
"code": "HUSBAND",
"description": "Husband",
"value": "Husband"
},
{
"code": "FATHER_IN_LAW",
"description": "Father in Law",
"value": "Father in Law"
},
{
"code": "MOTHER_IN_LAW",
"description": "Mother in Law",
"value": "Mother in Law"
},
{
"code": "AUNTY",
"description": "Aunty",
"value": "Aunty"
},
{
"code": "UNCLE",
"description": "Uncle",
"value": "Uncle"
},
{
"code": "COUSIN",
"description": "Cousin",
"value": "Cousin"
},
{
"code": "NEPHEW",
"description": "Nephew",
"value": "Nephew"
},
{
"code": "NIECE",
"description": "Niece",
"value": "Niece"
},
{
"code": "GRAND_MOTHER",
"description": "Grand Mother",
"value": "Grand Mother"
},
{
"code": "GRAND_FATHER",
"description": "Grand Father",
"value": "Grand Father"
},
{
"code": "GRAND_DAUGHTER",
"description": "Grand Daughter",
"value": "Grand Daughter"
},
{
"code": "GRAND_SON",
"description": "Grand Son",
"value": "Grand Son"
},
{
"code": "FRIEND",
"description": "Friend",
"value": "Friend"
},
{
"code": "FRIENDS_FATHER",
"description": "Friend's Father",
"value": "Friend's Father"
},
{
"code": "FRIENDS_MOTHER",
"description": "Friend's Mother",
"value": "Friend's Mother"
},
{
"code": "SELF",
"description": "Self",
"value": "Self"
}
],
"field_category": "Additional Data"
}
]
}
]
}Let's examine one of the fields in the recipient form:
JSON
{
"field_key": "account_type",
"field_label": "Bank Account Type",
"field_type": "string",
"is_mandatory": true,
"is_editable": false,
"enum_key": "account_type",
"values_supported": [
{
"code": "SAVINGS_ACCOUNT",
"description": "Savings Account",
"value": "Savings Account"
},
{
"code": "CURRENT_ACCOUNT",
"description": "Current Account",
"value": "Current Account"
}Important field parameters:
field_key— is the field name and key; you will use this to define the key:value pairs during recipient creation.is_mandatory— is the flag that determines whether the field is required or notis_editable— is the flag that determines if the field can be edited or updated after the recipient's creationvalues_supported— will appear when an enum is the required value for the field
All fields that are marked as mandatory must be provided by the customer (sender).
Call Create Remittance Recipient (POST /users/wallets/payouts/remittances/recipients) passing the route, remittance mode definition, and required beneficiary data.
Create Remittance Recipient request
CURL
curl --location 'https://{{payouts_base_url}}/{{program_code}}/v2/users/wallets/payouts/remittances/recipients' \
--header 'X-Auth-User-ID: {{user_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data-raw '{
"receiving_institution_type": "BANK",
"recipient_type": "INDIVIDUAL",
"receiving_currency": "USD",
"recipient_country": "USA",
"recipient_data": {
"user_information": {
"first_name": "Steven",
"last_name": "Smith",
"email": "stevensmith@matchmove.com",
"mobile_country_code": "1",
"mobile": "2125550123"
},
"address_details": {
"address_line_1": "1500",
"address_line_2": "Broadway",
"city": "New York",
"state": "NY",
"postal_code": "10036",
"country": "USA"
},
"bank_details": {
"account_type": "SAVINGS_ACCOUNT",
"account_name": "Steven Smith",
"account_number": "2988638169",
"code": "123456789",
"bank_id": "786bbfd4344a489391582eb8ba931604"
},
"additional_data": {
"purpose_of_payment": "FAMILY_MAINTENANCE"
}
}
}
'Create Remittance Recipient response
JSON
{
"id": "f3dc5d8578a14603bab94f51943a53a3",
"receiving_institution_type": "BANK",
"recipient_type": "INDIVIDUAL",
"receiving_currency": "USD",
"recipient_country": "USA",
"status": "PENDING",
"created_by": "1d2f696095bfe563058484b66d0a25fa",
"created_at": "2025-12-16T15:48:45 +08:00",
"updated_by": "",
"updated_at": "",
"deleted_by": "",
"deleted_at": "",
"user": {
"id": "1d2f696095bfe563058484b66d0a25fa",
"type": "INDIVIDUAL"
},
"payment_rail": "LOCAL",
"additional_data": {
"purpose_of_payment": "Family Maintenance",
"user_recipient_relationship": ""
},
"address_details": {
"address_line_1": "1500",
"address_line_2": "Broadway",
"address_line_3": "",
"address_line_4": "",
"city": "New York",
"country": "USA",
"nationality": "",
"postal_code": "10036",
"state": "NY"
},
"bank_details": {
"account_name": "Steven Smith",
"account_number": "2988638169",
"account_type": "Savings Account",
"bank_id": "786bbfd4344a489391582eb8ba931604",
"bank_name": "1ST SECURITY BANK OF WASHINGTON",
"branch_code": "",
"code": "123456789"
},
"identification_details": {
"country_of_issue": "",
"date_of_incorporation": "",
"expiry_date": "",
"identity_number": "",
"identity_type": "",
"issue_date": ""
},
"user_information": {
"date_of_birth": "",
"email": "stevensmith@matchmove.com",
"first_name": "Steven",
"gender": "",
"last_name": "Smith",
"middle_name": "",
"mobile": "2125550123",
"mobile_country_code": "1",
"occupation": "",
"preferred_name": ""
}
}Recipient Cooling-Off Period - Cross-border
A cooling-off period is a mandatory waiting timeframe that restricts account functions like withdrawals and transfers. This safeguard prevents system abuse and provides a "buffer" to detect fraudulent activity before funds move.
In the MatchMove platform, this period occurs between a recipient's creation and activation. It acts as a primary fraud prevention layer, ensuring suspicious actions are intercepted before payouts are authorized.
Timing and Logic
- Parallel Execution:
- The cooling period begins at creation and runs simultaneously with the risk evaluation. During this stage the user state will be set to
user.status = PENDING, while theuser.sub_statuswill indicate the progress:RISK_EVALUATION_IN_PROGRESS— will block user activationCOOLING_PERIOD_IN_PROGRESS— will block user activationRISK_EVALUATION_CLEAR— will allow user activation if the cooling period is also completed.COOLING_PERIOD_COMPLETED— will allow user activation if the risk evaluation has cleared the user.
- Activation Requirement: Both the cooling period and risk evaluation must independently finish before a recipient
user.statustransitions from theCREATEDtoPENDINGtoACTIVE. A customer (sender) will only be able to send a remittance toACTIVErecipients; otherwise, the transaction will be blocked by the platform.
3
Monitor the status changes on recipients
Cross-border payout events will need to be handled properly for a smoother payout journey for the customer.
If the partner wants to be notified of cross-border payout events, they must subscribe to the “Transaction Payouts Advisory” webhook category and events. This webhook will notify the partner for risk-cleared results and for cases when the recipient status is risk-flagged. The webhook receipt will be the signal for the partner to initiate the MatchMove Compliance — Risk Exemption Process to exempt the recipient in cases of false-positive hits.
Go to the Leveraging Webhooks section to learn more about setting up the webhooks.
PAYOUT.RECIPIENT.CROSSBORDER.STATUS | A notification is sent if the recipient profile |
|
Sample Recipient Status webhook payload
JSON
{
"event_data": {
"event_timestamp": "2025-12-08 07:54:49+0000",
"version": "v2",
"webhook_event": "PAYOUT.RECIPIENT.CROSSBORDER.STATUS",
"program_code": "{{produc_code}}",
"message_id": "f612ecb8f3364ede8fafccf1bac9ae64",
"entity_type": "Transaction",
"entities": {
"additional_data": {
"purpose_of_payment": "Education",
"user_recipient_relationship": ""
},
"address_details": {
"address_line_1": "211 Montrose",
"address_line_2": "Stillorgan Rd",
"address_line_3": "",
"address_line_4": "",
"city": "Dublin",
"country": "IRL",
"nationality": "",
"postal_code": "D04AE48",
"state": "Dublin"
},
"bank_details": {
"account_name": "A******a",
"account_type": "Savings Account",
"bank_id": "a69b7f1919414b7ab8079eb498d72ac0",
"bank_name": "AIB BANK",
"iban": "IE06AIBK93357078188028"
},
"created_at": "2025-06-28T14:36:49 +08:00",
"created_by": "976603fdeb4b97ebc1372253770efb6e",
"deleted_at": "",
"deleted_by": "",
"id": "9c3a7a5ade2e41e58969d742aa8968a7",
"identification_details": {
"country_of_issue": "",
"date_of_incorporation": "",
"expiry_date": "",
"identity_number": "",
"identity_type": "",
"issue_date": ""
},
"receiving_currency": "EUR",
"receiving_institution_type": "BANK",
"recipient_country": "IRL",
"recipient_type": "INDIVIDUAL",
"status": "ACTIVE",
"updated_at": "2025-06-28T14:37:01 +08:00",
"updated_by": "SYSTEM",
"user": {
"email": "paw****ma@yahoo.com",
"id": "976603fdeb4b97ebc1372253770efb6e",
"mobile": "9819340970",
"mobile_country_code": "91",
"type": "INDIVIDUAL"
},
"user_information": {
"date_of_birth": "",
"email": "ad******ma@gmail.com",
"first_name": "A***i",
"gender": "",
"last_name": "V***a",
"middle_name": "",
"mobile": "870379717",
"mobile_country_code": "353",
"occupation": "",
"preferred_name": ""
}
},
"event_name": "PAYOUT.RECIPIENT.CROSSBORDER.STATUS",
"product_code": "{{program_code}}",
"service_name": "svc-transactions-payouts-crossborder",
"trace_id": "0a045ecc7d4e499d9805715f0172b7d9"
}
}Related Links
Was this section helpful?
On this page
- Create a recipient for cross-border payment