Utilize enumerations
About Enumerations
Enumeration endpoints are helper endpoints for respective businesses to serve dynamic values supported on the platform.
Why Enumerations
Certain values change regularly due to the evolving business environment. While updates are infrequent, partners are encouraged to consume and rely on these dynamic values to provide the best possible experience for their customers.
There are a few business use cases that highlight the need for relying on and consuming these enumerations:
- Regulatory updates on the sanction list that affects platform-enabled regions
- Regulatory updates on the sanction list that affect onboarding fields like mobile country code
- Updates on supported ID types accepted for onboarding
- Knowing the availability of banks during maintenance periods before initiating payout transactions
These are just a few reasons why platform enumerations are important. Learn more about individual enumerations in their respective guides.
Platform Enumerations API
Platform Enumerations
Platform Enumerations
Identity & Onboarding | List Mobile Country Code Enumerations |
| Create a beneficiary bank account (receiver) for domestic payout transfers |
Identity & Onboarding | List Nationality Enumerations |
| Allowed nationality values for onboarding fields |
Identity & Onboarding | List Marital Status Enumerations |
| Allowed marital status values for onboarding fields |
Identity & Onboarding | List Genders Enumerations |
| Allowed genders values for onboarding fields |
Identity & Onboarding | List Countries Enumerations |
| Allowed countries values for onboarding fields |
Identity & Onboarding | List Titles Enumerations |
| Allowed titles values for onboarding fields |
Identity & Onboarding | List ID Types Enumerations |
| Allowed ID types values for onboarding fields |
Identity & Onboarding | List Document Types Enumerations |
| Allowed document types values for onboarding fields |
Identity & Onboarding | List KYC Types Enumerations |
| Allowed KYC types values for onboarding fields |
Identity & Onboarding | List Source of Income Enumerations |
| Allowed source of income values for onboarding fields |
Identity & Onboarding | List File Types Enumerations |
| Allowed source of income values for onboarding fields |
Identity & Onboarding | List Employment Type Enumerations |
| Allowed employment types values for onboarding fields specifically for PH region |
Identity & Onboarding | List Occupations Enumerations |
| Allowed occupations values for onboarding fields specifically for PH region |
Identity & Onboarding | List City Enumerations |
| Allowed city values for onboarding fields specifically for PH region |
Identity & Onboarding | List Barangay Enumerations (line_3) |
| Allowed barangay values for onboarding fields specifically for PH region |
Identity & Onboarding | List State or Province Enumerations |
| Allowed state or province values for onboarding fields specifically for PH region |
Identity & Onboarding | List Region Enumerations |
| Allowed region values for onboarding fields specifically for PH region |
Identity & Onboarding | List Postal Code Enumerations |
| Allowed portal code for onboarding fields specifically for PH region |
Identity & Onboarding | List Business ID Types Enumerations |
| Allowed business ID types values for onboarding fields |
Identity & Onboarding | List Business Roles Enumerations |
| Allowed business roles values for onboarding fields |
Identity & Onboarding | List Source of Funds Enumerations |
| Allowed source of funds values for onboarding fields |
Identity & Onboarding | List Purpose of Account Enumerations |
| Allowed purpose of account values for onboarding fields |
Identity & Onboarding | List Business Document Types Enumerations |
| Allowed business document types values for onboarding fields |
Domestic Payouts | List Domestic Payout Transfer Purpose Enumerations |
| Allowed transfer purpose values for domestic payout fields |
Domestic Payouts | List Domestic Payout Agents Enumerations |
| Allowed domestic transfer agents values for payout fields |
Cross-border Payouts | List Cross-border Payout Purpose Enumerations |
| Allowed transfer purpose values for cross-border payout fields |
Sample Identity Enumeration Requests
Sample Identity Enumeration Requests
List Mobile Country Code Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/mobile_country_codes' \
--header 'Authorization: ••••••'
List Mobile Country Code Enumerations response
{
"mobile_country_codes": [
{
"code": "ABW",
"description": "+297"
},
{
"code": "AGO",
"description": "+244"
},
{
"code": "AIA",
"description": "+1"
},
..
List Nationality Enumerations request
curl --location 'https://{{identity_base_url}}/{{prodduct_code}}/v2/users/enumerations/nationalities' \
--header 'Authorization: ••••••'
List Nationality Enumerations response
{
"nationalities": [
{
"code": "Afghan",
"description": "Nationality for Afghanistan"
},
{
"code": "Landers",
"description": "Nationality for Aland Islands"
},
{
"code": "Albanian",
"description": "Nationality for Albania"
},
..
List Marital Status Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/marital_status' \
--header 'Authorization: ••••••'
List Marital Status Enumerations response
{
"marital_status": [
{
"code": "DIVORCED",
"description": "Divorced"
},
{
"code": "MARRIED",
"description": "Married"
},
{
"code": "NA",
"description": "N/A"
},
..
List Genders Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/genders' \
--header 'Authorization: ••••••'
List Genders Enumerations response
{
"genders": [
{
"code": "female",
"description": "Female"
},
{
"code": "male",
"description": "Male"
}
]
}
List Countries Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/countries' \
--header 'Authorization: ••••••'
List Countries Enumerations response
{
"countries": [
{
"code": "AFG",
"description": "Afghanistan"
},
{
"code": "ALA",
"description": "Aland Islands"
},
{
"code": "ALB",
"description": "Albania"
},
..
List Titles Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/titles' \
--header 'Authorization: ••••••'
List Titles Enumerations response
{
"titles": [
{
"code": "Dr",
"description": "Dr"
},
{
"code": "Madam",
"description": "Madam"
},
{
"code": "Miss",
"description": "Miss"
},
..
List ID Types Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/id_types' \
--header 'Authorization: ••••••'
List ID Types Enumerations response
{
"id_types": {
"primary": [
{
"code": "ep",
"description": {
"display_name": "Employee Pass",
"regex_validation": "/^[a-zA-Z0-9]*$/"
}
},
{
"code": "epfin",
"description": {
"display_name": "EP FIN No.",
"regex_validation": "/^[a-zA-Z0-9]*$/"
}
},
..
List Document Types Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/document_types' \
--header 'Authorization: ••••••'
List Document Types Enumerations response
{
"document_types": [
{
"code": "back_of_id_document",
"description": "back_of_id_document"
},
{
"code": "customer_occupation_details",
"description": "customer_occupation_details"
},
..
List KYC Types Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/kyc_types' \
--header 'Authorization: ••••••'
List KYC Types Enumerations response
{
"kyc_types": [
{
"code": "EKYC_MYINFO",
"description": "EKYC_MYINFO"
},
{
"code": "KYC_SERVICE",
"description": "KYC_SERVICE"
},
{
"code": "MM_DOCUMENT_UPLOAD",
"description": "MM_DOCUMENT_UPLOAD"
},
..
List Source of Income Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/main_income_source' \
--header 'Authorization: ••••••'
List Source of Income Enumerations response
{
"main_income_source": [
{
"code": "BANK",
"description": "Bank"
},
{
"code": "COBRANDING_PARTNER",
"description": "Cobranding Partner"
},
{
"code": "LOAN_PROCEEDS",
"description": "Loan Proceeds"
},
..
List File Types Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/file_types' \
--header 'Authorization: ••••••'
List File Types Enumerations response
{
"file_types": [
{
"code": "id",
"label": "ID"
},
{
"code": "video",
"label": "Video"
},
..
List Employment Types Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/employment_type' \
--header 'Authorization: ••••••'
List Employment Types Enumerations response
{
"employment_type": [
{
"code": "COMMISSION_BASED_AGENT",
"description": "Commission Based Agent"
},
{
"code": "DEPENDENT",
"description": "Dependent"
},
{
"code": "EMPLOYED_CONTRACTUAL",
"description": "Employed Contractual"
},
..
List Occupations Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/occupations' \
--header 'Authorization: ••••••'
List Occupations Enumerations response
{
"occupations": [
{
"code": "accountant",
"description": "Accountant"
},
{
"code": "actor",
"description": "Actor"
},
..
List City Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/city' \
--header 'Authorization: ••••••'
List City Enumerations response
{
"city": [
{
"code": "ABORLAN_PALAWAN",
"description": "Aborlan, Palawan"
},
{
"code": "ABRA_DE_ILOG_OCCIDEN",
"description": "Abra De Ilog, Occidental Mindoro"
},
{
"code": "ABUCAY_BATAAN",
"description": "Abucay, Bataan"
},
..
List Barangay Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/line_3' \
--header 'Authorization: ••••••'
List Barangay Enumerations response
{
"line_3": [
{
"code": "50TH_DISTRICT",
"description": "50th District"
},
{
"code": "A_ET",
"description": "A-et"
},
{
"code": "A_BELTRAN",
"description": "A. Beltran"
},
{
"code": "A_BONIFACIO",
"description": "A. Bonifacio"
},
{
"code": "A_BONIFACIO_CAGUIOA_RIMANDO",
"description": "A. Bonifacio-Caguioa-Rimando"
},
..
List State or Province Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/state_province' \
--header 'Authorization: ••••••'
List State or Province Enumerations response
{
"state_province": [
{
"code": "ABRA",
"description": "ABRA"
},
{
"code": "AGUSANDELNORTE",
"description": "AGUSAN DEL NORTE"
},
{
"code": "AGUSANDELSUR",
"description": "AGUSAN DEL SUR"
},
..
List Region Enumerations request
curl --location 'https://{{identityHostname}}/{{program_code}}/v2/users/enumerations/line_4' \
--header 'Authorization: ••••••'
List Region Enumerations response
{
"line_4": [
{
"code": "REGION_01",
"description": "Region I"
},
{
"code": "REGION_02",
"description": "Region II"
},
{
"code": "REGION_03",
"description": "Region III"
},
..
List Postal Code Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/postal_code' \
--header 'Authorization: ••••••'
List Postal Code Enumerations response
{
"postal_code": [
{
"code": "400",
"description": "400"
},
{
"code": "401",
"description": "401"
},
{
"code": "410",
"description": "410"
},
..
List Business Roles Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/business_roles' \
--header 'Authorization: ••••••'
List Business Roles Enumerations response
{
"business_roles": [
{
"code": "END_USER",
"description": "End User"
},
{
"code": "PLATFORM_USER",
"description": "Platform User"
},
..
List Source of Funds Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/business_source_of_funds' \
--header 'Authorization: ••••••'
List Source of Funds Enumerations response
{
"business_source_of_funds": [
{
"code": "DEBT",
"description": "Debt"
},
{
"code": "DEBT_CAPITAL",
"description": "Debt Capital"
},
..
List Purpose of Account Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/business_purpose_of_account' \
--header 'Authorization: ••••••'
List Purpose of Account Enumerations response
{
"business_purpose_of_account": [
{
"code": "CASH_DEPOSIT",
"description": "Cash Deposit"
},
{
"code": "CASH_WITHDRAWAL",
"description": "Cash Withdrawal"
},
..
List Business Document Types Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/business_document_types' \
--header 'Authorization: ••••••'
List Business Document Types Enumerations response
{
"business_document_types": [
{
"code": "ACCOUNTING_CORPORATE_REGULATORY_AUTHORITY_REPORT",
"description": "Accounting Corporate Regulatory Authority Report"
},
{
"code": "BOARD_RESOLUTION",
"description": "Board Resolution"
},
..
Sample Payouts Enumeration Requests
Sample Payouts Enumeration Requests
List Domestic Payout Transfer Agents Enumerations request
curl --location 'https:/{{payouts_base_url}}/{{program_code}}/v1/users/wallets/payouts/domestic/enumerations/transfer_agents' \
--header 'Authorization: ••••••'
List Domestic Payout Transfer Agents Enumerations response
{
"total_records": 39,
"records_per_page": 10,
"total_pages": 4,
"page": 1,
"links": [
{
"rel": "self",
"href": "https://api-op-application.matchmove-beta.com/{{program_code}}/v2/users/enumerations/domestic_transfer/agents?page=1&records_per_page=10&return_all=false",
"method": "GET"
},
{
"rel": "next",
"href": "https://api-op-application.matchmove-beta.com/{{program_code}}/v2/users/enumerations/domestic_transfer/agents?page=2&records_per_page=10&return_all=false",
"method": "GET"
}
],
"data": [
{
"agent_code": "ANZBSGS0XXX",
"agent_logo": "https://assets.mmvpay.com/sg/domestic_transfer_agents/ANZ_BANK.png",
"mode": "bank",
"name": "ANZ Bank",
"status": "active",
"bic_code": "ANZBSGS0XXX",
"fees": {
"fixed": "0.000000",
"percentage": "0.000000",
"variable": "",
"fee_calculation_type": ""
},
"transfer_details": [
{
"channel_id": "382dd1f29f9411ec875a02b5044dcedc",
"channel": "FAST",
"min_transfer_amount": "0.01",
"max_transfer_amount": "200000.00",
"transfer_fulfillment_time": "Instant"
}
],
"account_number_regex": "^[0-9]*$",
"account_number_min_length": "5",
"account_number_max_length": "34"
},
..
List Domestic Payout Transfer Purpose Enumerations request
curl --location 'https://{{payouts_base_url}}/{{program_code}}/v1/users/wallets/payouts/domestic/enumerations/transfer_purpose' \
--header 'Authorization: ••••••'
List Domestic Payout Transfer Purpose Enumerations response
{
"purpose_of_transfer": [
{
"code": "ACCT",
"description": "Account Management"
},
{
"code": "ADVA",
"description": "Advance Payment"
},
{
"code": "AGRT",
"description": "Agricultural Transfer"
},
{
"code": "AIRB",
"description": "Air"
..
List Cross-border Payout Transfer Purpose Enumerations request
curl --location 'https://{{payouts_base_url}}/{{program_code}}/v2/users/enumerations/transfers/purpose' \
--header 'Authorization: ••••••'
List Cross-border Payout Transfer Purpose Enumerations response
{
"purpose_of_transfer": [
{
"code": "ACCT",
"description": "Account Management"
},
{
"code": "ADVA",
"description": "Advance Payment"
},
..
Related Links
On this page
- Utilize enumerations