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 | Mobile Country Code Enumeration |
| Create a beneficiary bank account (receiver) for domestic payout transfers |
Identity & Onboarding | Nationality Enumeration |
| Allowed nationality values for onboarding fields |
Identity & Onboarding | Marital Status Enumeration |
| Allowed marital status values for onboarding fields |
Identity & Onboarding | Genders Enumeration |
| Allowed genders values for onboarding fields |
Identity & Onboarding | Countries Enumeration |
| Allowed countries values for onboarding fields |
Identity & Onboarding | Titles Enumeration |
| Allowed titles values for onboarding fields |
Identity & Onboarding | ID Types Enumeration |
| Allowed ID types values for onboarding fields |
Identity & Onboarding | Document Types Enumeration |
| Allowed document types values for onboarding fields |
Identity & Onboarding | KYC Types Enumeration |
| Allowed KYC types values for onboarding fields |
Identity & Onboarding | Source of Income Enumeration |
| Allowed source of income values for onboarding fields |
Identity & Onboarding | File Types Enumeration |
| Allowed source of income values for onboarding fields |
Identity & Onboarding | Employment Type Enumeration |
| Allowed employment types values for onboarding fields specifically for PH region |
Identity & Onboarding | Occupations Enumeration |
| Allowed occupations values for onboarding fields specifically for PH region |
Identity & Onboarding | City Enumeration |
| Allowed city values for onboarding fields specifically for PH region |
Identity & Onboarding | State or Province Enumeration |
| Allowed state or province values for onboarding fields specifically for PH region |
Identity & Onboarding | Region Enumeration |
| Allowed region values for onboarding fields specifically for PH region |
Identity & Onboarding | Postal Code Enumeration |
| Allowed portal code for onboarding fields specifically for PH region |
Identity & Onboarding | Business ID Types Enumeration |
| Allowed business ID types values for onboarding fields |
Identity & Onboarding | Business Roles Enumeration |
| Allowed business roles values for onboarding fields |
Identity & Onboarding | Source of Funds Enumeration |
| Allowed source of funds values for onboarding fields |
Identity & Onboarding | Purpose of Account Enumeration |
| Allowed purpose of account values for onboarding fields |
Identity & Onboarding | Business Document Types Enumeration |
| Allowed business document types values for onboarding fields |
Identity & Onboarding Domestic Payouts | Transfer Purpose Enumeration |
| Allowed transfer purpose values for onboarding and payout fields |
Domestic Payouts | Domestic Transfer Agents Enumerations |
| Allowed domestic transfer agents values for payout fields |
Sample Identity Enumeration Requests
Sample Identity Enumeration Requests
Mobile Country Code request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/mobile_country_codes' \
--header 'Authorization: ••••••'Mobile Country Code response
{
"mobile_country_codes": [
{
"code": "ABW",
"description": "+297"
},
{
"code": "AGO",
"description": "+244"
},
{
"code": "AIA",
"description": "+1"
},..Nationality Enumeration request
curl --location 'https://{{identity_base_url}}/{{prodduct_code}}/v1/users/enumerations/nationalities' \
--header 'Authorization: ••••••'Nationality Enumeration response
{
"nationalities": [
{
"code": "Afghan",
"description": "Nationality for Afghanistan"
},
{
"code": "Landers",
"description": "Nationality for Aland Islands"
},
{
"code": "Albanian",
"description": "Nationality for Albania"
},..Marital Status Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/marital_status' \
--header 'Authorization: ••••••'Marital Status Enumeration response
{
"marital_status": [
{
"code": "DIVORCED",
"description": "Divorced"
},
{
"code": "MARRIED",
"description": "Married"
},
{
"code": "NA",
"description": "N/A"
},..Genders Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/genders' \
--header 'Authorization: ••••••'Genders Enumeration response
{
"genders": [
{
"code": "female",
"description": "Female"
},
{
"code": "male",
"description": "Male"
}
]
}Countries Enumerations request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/countries' \
--header 'Authorization: ••••••'Countries Enumerations response
{
"countries": [
{
"code": "AFG",
"description": "Afghanistan"
},
{
"code": "ALA",
"description": "Aland Islands"
},
{
"code": "ALB",
"description": "Albania"
},..Titles Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/titles' \
--header 'Authorization: ••••••'Titles Enumeration response
{
"titles": [
{
"code": "Dr",
"description": "Dr"
},
{
"code": "Madam",
"description": "Madam"
},
{
"code": "Miss",
"description": "Miss"
},..ID Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/id_types' \
--header 'Authorization: ••••••'ID Types Enumeration 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]*$/"
}
},..Document Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/document_types' \
--header 'Authorization: ••••••'Document Types Enumeration response
{
"document_types": [
{
"code": "back_of_id_document",
"description": "back_of_id_document"
},
{
"code": "customer_occupation_details",
"description": "customer_occupation_details"
},..KYC Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/kyc_types' \
--header 'Authorization: ••••••'KYC Types Enumeration response
{
"kyc_types": [
{
"code": "EKYC_MYINFO",
"description": "EKYC_MYINFO"
},
{
"code": "KYC_SERVICE",
"description": "KYC_SERVICE"
},
{
"code": "MM_DOCUMENT_UPLOAD",
"description": "MM_DOCUMENT_UPLOAD"
},..Source of Income Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/main_income_source' \
--header 'Authorization: ••••••'Source of Income Enumeration response
{
"main_income_source": [
{
"code": "BANK",
"description": "Bank"
},
{
"code": "COBRANDING_PARTNER",
"description": "Cobranding Partner"
},
{
"code": "LOAN_PROCEEDS",
"description": "Loan Proceeds"
},..File Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/file_types' \
--header 'Authorization: ••••••'File Types Enumeration response
{
"file_types": [
{
"code": "id",
"label": "ID"
},
{
"code": "video",
"label": "Video"
},..Employment Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/employment_type' \
--header 'Authorization: ••••••'Employment Types Enumeration response
{
"employment_type": [
{
"code": "COMMISSION_BASED_AGENT",
"description": "Commission Based Agent"
},
{
"code": "DEPENDENT",
"description": "Dependent"
},
{
"code": "EMPLOYED_CONTRACTUAL",
"description": "Employed Contractual"
},..Occupations Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/occupations' \
--header 'Authorization: ••••••'Occupations Types Enumeration response
{
"occupations": [
{
"code": "accountant",
"description": "Accountant"
},
{
"code": "actor",
"description": "Actor"
},..City Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/city' \
--header 'Authorization: ••••••'City Enumeration 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"
},..State or Province Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v2/users/enumerations/state_province' \
--header 'Authorization: ••••••'State or Province Enumeration response
{
"state_province": [
{
"code": "ABRA",
"description": "ABRA"
},
{
"code": "AGUSANDELNORTE",
"description": "AGUSAN DEL NORTE"
},
{
"code": "AGUSANDELSUR",
"description": "AGUSAN DEL SUR"
},..Region Enumeration request
curl --location 'https://{{identityHostname}}/{{program_code}}/v2/users/enumerations/line_4' \
--header 'Authorization: ••••••'Region Enumeration response
{
"line_4": [
{
"code": "REGION_01",
"description": "Region I"
},
{
"code": "REGION_02",
"description": "Region II"
},
{
"code": "REGION_03",
"description": "Region III"
},..Postal Code Enumeration request
curl --location 'https://api-sg-identity.matchmove-beta.com/phluvit/v2/users/enumerations/postal_code' \
--header 'Authorization: ••••••'Postal Code Enumeration response
{
"postal_code": [
{
"code": "400",
"description": "400"
},
{
"code": "401",
"description": "401"
},
{
"code": "410",
"description": "410"
},..Business Roles Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/business_roles' \
--header 'Authorization: ••••••'Business Roles Enumeration response
{
"business_roles": [
{
"code": "END_USER",
"description": "End User"
},
{
"code": "PLATFORM_USER",
"description": "Platform User"
},..Source of Funds Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/business_source_of_funds' \
--header 'Authorization: ••••••'Source of Funds Enumeration response
{
"business_source_of_funds": [
{
"code": "DEBT",
"description": "Debt"
},
{
"code": "DEBT_CAPITAL",
"description": "Debt Capital"
},..Purpose of Account Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/business_purpose_of_account' \
--header 'Authorization: ••••••'Purpose of Account Enumeration response
{
"business_purpose_of_account": [
{
"code": "CASH_DEPOSIT",
"description": "Cash Deposit"
},
{
"code": "CASH_WITHDRAWAL",
"description": "Cash Withdrawal"
},..Business Document Types Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/business_document_types' \
--header 'Authorization: ••••••'Business Document Types Enumeration response
{
"business_document_types": [
{
"code": "ACCOUNTING_CORPORATE_REGULATORY_AUTHORITY_REPORT",
"description": "Accounting Corporate Regulatory Authority Report"
},
{
"code": "BOARD_RESOLUTION",
"description": "Board Resolution"
},..Transfer Purpose Enumeration request
curl --location 'https://{{identity_base_url}}/{{program_code}}/v1/users/enumerations/transfers/purpose' \
--header 'Authorization: ••••••'Transfer Purpose Enumeration response
{
"purpose_of_transfer": [
{
"code": "ACCT",
"description": "Account Management"
},
{
"code": "ADVA",
"description": "Advance Payment"
},..Sample Payouts Enumeration Requests
Sample Payouts Enumeration Requests
Domestic Transfer Agents Enumeration request
curl --location 'https:/{{payouts_base_url}}/{{program_code}}/v1/users/wallets/payouts/domestic/enumerations/transfer_agents' \
--header 'Authorization: ••••••'Domestic Transfer Agents Enumeration 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}}/v1/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}}/v1/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"
},..Related Links
On this page
- Utilize enumerations