nCore API

https://docs.nymcard.com/
Admin
nCore is a comprehensive card issuance and payment platform providing APIs for card issuing, product...
Tokens:146,729
Snippets:1,138
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example of Querying Documentation

Source: https://docs.nymcard.com/get-started/product-management/multi-currency

This example demonstrates how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.nymcard.com/get-started/product-management/multi-currency.md?ask=<question>
```

--------------------------------

### Example HTTP GET Request for Dynamic Documentation Query

Source: https://docs.nymcard.com/get-started/release-announcements/changes-in-the-release-on-23-05-2023

To get additional information not explicitly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/release-announcements/changes-in-the-release-on-23-05-2023.md?ask=<question>
```

--------------------------------

### Query Documentation Example

Source: https://docs.nymcard.com/get-started/issuing-physical-cards/individual-card-issuance

To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/issuing-physical-cards/individual-card-issuance.md?ask=<question>
```

--------------------------------

### Get FX Rate Providers API Response Example

Source: https://docs.nymcard.com/get-started/product-management/multi-currency

This is an example response from the newly created 'Get all FX rate providers' API, listing available FX providers and their configurations.

```json
{
    "data": [
        {
            "provider_id": "FEXCOID",
            "provider_name": "FEXCO",
            "type": "EXTERNAL",
            "status": "ACTIVE",
            "rate_expiry_buffer_time": 5,
            "fxrate_mode": [
                {
                    "transaction_type": "TRANSFERS",
                    "mode": "ONLINE"
                },
                {
                    "transaction_type": "SWEEP",
                    "mode": "ONLINE"
                }
            ],
            "fxrate_provider_groups": [
                {
                    "provider_group_id": "4",
                    "status": "ACTIVE"
                }
            ],
            "created": "2023-05-24T10:48:28.283Z",
            "modified": "2023-05-24T10:48:28.283Z"
        },
         ….


```

--------------------------------

### Query documentation dynamically

Source: https://docs.nymcard.com/get-started/product-management/authorization-controls/enhancements-for-mcc-list-management

To get information not explicitly on the page, perform an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.nymcard.com/get-started/product-management/authorization-controls/enhancements-for-mcc-list-management.md?ask=<question>
```

--------------------------------

### Get next set of users

Source: https://docs.nymcard.com/get-started/api-core-principles

Use the 'limit' and 'after' query parameters to paginate through results. This example retrieves the next 5 users following a specific cursor.

```http
GET /users?limit=5&after=a213fe
```

--------------------------------

### Create Card Request Example

Source: https://docs.nymcard.com/get-started/api-core-principles

This example demonstrates how to create a new card by sending a POST request to the /cards endpoint. Ensure you include your API key in the Authorization header and provide the necessary user and card details in the JSON body.

```json
"Headers:"
"apikey: 2baeed-234fe-2323acf"
"{"
"    "user_id": "d089a80f-e641-4045-8a80-54841e4a7458","
"    "card_type": "VIRTUAL","
"    "card_product_id": "b4eabfc-f839-4e51""
"}"
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started/funding-and-transfers/external-funding-source/dapi-direct-api-flow

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicit, or you need clarification or related context.

```http
GET https://docs.nymcard.com/get-started/funding-and-transfers/external-funding-source/dapi-direct-api-flow.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and in natural language. Use this when the answer is not explicitly present or for clarification.

```http
GET https://docs.nymcard.com/get-started.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started/webhooks/webhook-changes-for-simulation

To get additional information not directly present on the page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/webhooks/webhook-changes-for-simulation.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started/funding-and-transfers

To get information not explicitly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.nymcard.com/get-started/funding-and-transfers.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.nymcard.com/get-started/funding-and-transfers/internal-funding-source

To get additional information not explicitly on this page, query the documentation using the 'ask' parameter in a GET request.

```http
GET https://docs.nymcard.com/get-started/funding-and-transfers/internal-funding-source.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started/product-management

Perform an HTTP GET request on a page URL with the `ask` query parameter to dynamically query documentation. The question should be specific and in natural language. Use this for information not explicitly present, clarifications, or related sections.

```http
GET https://docs.nymcard.com/get-started/product-management.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.nymcard.com/get-started/funding-and-transfers/funding

To get more information not present on the current page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.nymcard.com/get-started/funding-and-transfers/funding.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started/issuing-virtual-cards

Perform an HTTP GET request on a documentation URL with the `ask` query parameter to retrieve specific information. The question should be self-contained and in natural language.

```http
GET https://docs.nymcard.com/get-started/issuing-virtual-cards.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.nymcard.com/get-started/issuing-physical-cards/card-pin-management

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/issuing-physical-cards/card-pin-management.md?ask=<question>
```

--------------------------------

### Query Documentation

Source: https://docs.nymcard.com/get-started/transactions/transaction-endpoints-scenarios

To get additional information not directly available on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/transactions/transaction-endpoints-scenarios.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.nymcard.com/get-started/product-management/card-product

To get additional information not directly present on the page, perform an HTTP GET request to the current URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/product-management/card-product.md?ask=<question>
```

--------------------------------

### Example DAPI Widget URL with Encoded Transfer Parameters

Source: https://docs.nymcard.com/get-started/funding-and-transfers/external-funding-source/from-bank-account

This is an example of the complete DAPI widget URL after appending the base64 encoded fund transfer parameters. The URL facilitates the direct transfer of funds from a bank account.

```url
https://openbanking.sand.platform.nymcard.com/dapi_bank_list/42504465-5410-46fc-94e8-aa5bc062ada9%7Ctenant/eyJhY3Rpb24iOiJUUkFOU0ZFUl9GVU5EUyIsImJhbmtfaWQiOiJEQVBJQkFOS19BRV9IU0JDIiwiYW1vdW50IjoiMTAiLCJhY2NvdW50X251bWJlciI6MTY2ODUxMDc2MDM5ODYyMzIwNzE3OSwiYWxsb3dfdWlfZmxvdyI6IllFUyJ9
```

--------------------------------

### Create Card Product with Multi-Currency Settings

Source: https://docs.nymcard.com/get-started/product-management/multi-currency

This example demonstrates how to create a card product that supports multiple currencies by setting the `is_multi_currency_product` flag to true and configuring `wallet_settings` and `fxrates_settings`.

```APIDOC
## POST /card-products

### Description
Creates a new card product with specified multi-currency settings.

### Method
POST

### Endpoint
/card-products

### Request Body
- **is_multi_currency_product** (boolean) - Optional - Identifies if the card product supports multiple currencies. Defaults to false.
- **wallet_settings** (object) - Optional - Settings for managing wallets. Mandatory if `is_multi_currency_product` is true.
  - **initial_num_of_wallets_offered** (integer) - Specifies the initial number of wallets offered when a new card is issued.
  - **maximum_active_wallets_allowed** (integer) - Specifies the maximum number of active wallets a user can have at a time.
  - **maximum_wallets_allowed_in_sweep** (integer) - Specifies the maximum number of wallets to use in sweeping.
- **fxrates_settings** (array) - Optional - Links custom rate groups with the card product for different transaction types. Applicable if `is_multi_currency_product` is true.
  - **transaction_type** (string) - The type of transaction (e.g., "TRANSFERS", "SWEEP").
  - **rate_group_id** (string) - The ID of the custom rate group.

### Request Example
```json
{
  "is_multi_currency_product": true,
  "wallet_settings": {
    "initial_num_of_wallets_offered": 3,
    "maximum_active_wallets_allowed": 3,
    "maximum_wallets_allowed_in_sweep": 1
  },
  "fxrates_settings": [
    {
      "transaction_type": "TRANSFERS",
      "rate_group_id": "R1"
    },
    {
      "transaction_type": "SWEEP",
      "rate_group_id": "R2"
    }
  ]
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the created card product.
- **is_multi_currency_product** (boolean) - Indicates if the product is multi-currency.
- **wallet_settings** (object) - The configured wallet settings.
- **fxrates_settings** (array) - The configured FX rates settings.
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis

Demonstrates how to perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis.md?ask=<question>
```

--------------------------------

### Create Business User

Source: https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type

This example demonstrates how to create a business user by providing the required parameters such as 'business_legal_name' and 'business_dba_name'.

```APIDOC
## POST /v1/users

### Description
Creates a new user account. This example specifically shows the parameters required for a 'BUSINESS' user type.

### Method
POST

### Endpoint
https://api.dev.platform.nymcard.com/v1/users

### Parameters
#### Request Body
- **first_name** (string) - Required - The first name of the user.
- **user_type** (string) - Required - The type of user to create. Use "BUSINESS" for business users.
- **middle_name** (string) - Optional - The middle name of the user.
- **last_name** (string) - Required - The last name of the user.
- **native_name** (string) - Optional - The native name of the user.
- **date_of_birth** (string) - Optional - The date of birth in YYYY-MM-DD format.
- **email** (string) - Required - The email address of the user.
- **mobile** (string) - Optional - The mobile phone number.
- **address** (object) - Optional - User's address details.
  - **address_line1** (string) - Optional - First line of the address.
  - **address_line2** (string) - Optional - Second line of the address.
  - **city** (string) - Optional - City.
  - **state** (string) - Optional - State or province.
  - **postal_code** (string) - Optional - Postal code.
  - **country** (string) - Optional - Country code.
- **gender** (string) - Optional - Gender of the user.
- **preferred_language** (string) - Optional - Preferred language code.
- **place_of_birth** (string) - Optional - Place of birth.
- **nationality** (string) - Optional - Nationality.
- **country_residence** (string) - Optional - Country of residence.
- **country_tax_residence** (string) - Optional - Country of tax residence.
- **employment_type** (string) - Optional - Type of employment.
- **employment_title** (string) - Optional - Job title.
- **monthly_salary** (number) - Optional - Monthly salary amount.
- **company_name** (string) - Optional - Name of the company.
- **company_address** (object) - Optional - Company's address details.
  - **address_line1** (string) - Optional - First line of the address.
  - **address_line2** (string) - Optional - Second line of the address.
  - **city** (string) - Optional - City.
  - **state** (string) - Optional - State or province.
  - **postal_code** (string) - Optional - Postal code.
  - **country** (string) - Optional - Country code.
- **company_country** (string) - Optional - Country where the company is registered.
- **industry_type** (string) - Optional - Type of industry.
- **expected_monthly_balance** (number) - Optional - Expected monthly balance.
- **business_legal_name** (string) - Required for BUSINESS type - The legal name of the business.
- **business_dba_name** (string) - Required for BUSINESS type - The 'Doing Business As' name.
- **date_established** (string) - Optional - Date the business was established (YYYY-MM-DD).
- **phone_number** (string) - Optional - Business phone number.
- **website** (string) - Optional - Business website URL.
- **incorporation_type** (string) - Optional - Type of business incorporation.
- **entity_registered_no** (string) - Optional - Business registration number.
- **old_entity_name** (string) - Optional - Previous name of the entity.
- **old_entity_ops_start_date** (string) - Optional - Start date of old entity operations.
- **old_entity_ops_end_date** (string) - Optional - End date of old entity operations.
- **regulated_entity** (boolean) - Optional - Indicates if the entity is regulated.
- **regulator_name** (string) - Optional - Name of the regulator.
- **business_activities** (string) - Optional - Description of business activities.
- **other_operated_countries** (string) - Optional - Countries where the business operates.
- **tax_residence_country** (string) - Optional - Country of tax residence for the business.
- **tin** (string) - Optional - Tax Identification Number.
- **external_auditor_name** (string) - Optional - Name of the external auditor.
- **group_additional_info** (object) - Optional - Additional information about the group structure.
  - **group_entity** (boolean) - Optional - Is part of a group entity.
  - **independent_entity** (boolean) - Optional - Is an independent entity.
  - **special_investment** (boolean) - Optional - Is a special investment entity.
  - **entity_details** (string) - Optional - Details about the entity.
- **pep_check_info** (object) - Optional - Information related to Politically Exposed Person (PEP) checks.
  - **pri_pep_check** (boolean) - Optional - Primary PEP check status.
  - **pri_pep_check_name** (string) - Optional - Name associated with the primary PEP check.
  - **sec_pep_check** (boolean) - Optional - Secondary PEP check status.
  - **sec_pep_check_name** (string) - Optional - Name associated with the secondary PEP check.
- **accept_cash_check** (boolean) - Optional - Indicates if cash transactions are accepted.
- **annual_turnover** (string) - Optional - Annual turnover amount.
- **source_of_funds** (string) - Optional - Description of the source of funds.
- **source_fund_uae** (boolean) - Optional - Indicates if funds originate from UAE.
- **due_diligence_declaration** (object) - Optional - Declarations for due diligence.
  - **bankruptcy_declaration** (boolean) - Optional - Declaration regarding bankruptcy.
  - **disciplinary_declaration** (boolean) - Optional - Declaration regarding disciplinary actions.
  - **fraud_aml_declaration** (boolean) - Optional - Declaration regarding fraud or AML issues.
  - **disqualification_declaration** (boolean) - Optional - Declaration regarding disqualification.
  - **conviction_accusition_declaration** (boolean) - Optional - Declaration regarding convictions or accusations.
  - **breach_of_law_declaration** (boolean) - Optional - Declaration regarding breaches of law.

### Request Example
```json
{
  "first_name": "John",
  "user_type": "BUSINESS",
  "middle_name": "Anthony",
  "last_name": "pass",
  "native_name": "John Smith",
  "date_of_birth": "2000-09-28",
  "email": "bob@example.com",
  "mobile": "+551185249635",
  "address": {
    "address_line1": "Flat 1904",
    "address_line2": "Glass Tower",
    "city": "New York City",
    "state": "New York",
    "postal_code": "12345",
    "country": "UKR"
  },
  "gender": "MALE",
  "preferred_language": "EN",
  "place_of_birth": "USA",
  "nationality": "USA",
  "country_residence": "USA",
  "country_tax_residence": "USA",
  "employment_type": "SALARIED",
  "employment_title": "string",
  "monthly_salary": 0,
  "company_name": "string",
  "company_address": {
    "address_line1": "Flat 1904",
    "address_line2": "Glass Tower",
    "city": "New York City",
    "state": "New York",
    "postal_code": "12345",
    "country": "UKR"
  },
  "company_country": "USA",
  "industry_type": "I01",
  "expected_monthly_balance": 0,
  "business_legal_name": "string",
  "business_dba_name": "string",
  "date_established": "2021-09-28",
  "phone_number": "+551185249635",
  "website": "string",
  "incorporation_type": "LLC",
  "entity_registered_no": "22334455",
  "old_entity_name": "",
  "old_entity_ops_start_date": "2021-09-28T00:00:00.000Z",
  "old_entity_ops_end_date": "2021-09-28T00:00:00.000Z",
  "regulated_entity": true,
  "regulator_name": "XYZ",
  "business_activities": "Consultancy",
  "other_operated_countries": "UAE, US",
  "tax_residence_country": "UAE",
  "tin": "1122334455",
  "external_auditor_name": "",
  "group_additional_info": {
    "group_entity": true,
    "independent_entity": true,
    "special_investment": true,
    "entity_details": "name"
  },
  "pep_check_info": {
    "pri_pep_check": true,
    "pri_pep_check_name": "ABC",
    "sec_pep_check": true,
    "sec_pep_check_name": "XYZ"
  },
  "accept_cash_check": true,
  "annual_turnover": "120000",
  "source_of_funds": "IT services",
  "source_fund_uae": true,
  "due_diligence_declaration": {
    "bankruptcy_declaration": false,
    "disciplinary_declaration": false,
    "fraud_aml_declaration": false,
    "disqualification_declaration": false,
    "conviction_accusition_declaration": false,
    "breach_of_law_declaration": false
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created user.
- **first_name** (string) - The first name of the user.
- **middle_name** (string) - The middle name of the user.
- **last_name** (string) - The last name of the user.
- **native_name** (string) - The native name of the user.
- **date_of_birth** (string) - The date of birth in YYYY-MM-DD format.
- **email** (string) - The email address of the user.
- **mobile** (string) - The mobile phone number.
- **address** (object) - User's address details.
  - **address_line1** (string) - First line of the address.
  - **address_line2** (string) - Second line of the address.
  - **city** (string) - City.
  - **state** (string) - State or province.
  - **postal_code** (string) - Postal code.
  - **country** (string) - Country code.
- **gender** (string) - Gender of the user.
- **preferred_language** (string) - Preferred language code.
- **place_of_birth** (string) - Place of birth.
- **nationality** (string) - Nationality.
- **created** (string) - Timestamp when the user was created.
- **modified** (string) - Timestamp when the user was last modified.
- **country_residence** (string) - Country of residence.
- **country_tax_residence** (string) - Country of tax residence.
- **employment_type** (string) - Type of employment.
- **employment_title** (string) - Job title.
- **monthly_salary** (number) - Monthly salary amount.
- **company_name** (string) - Name of the company.
- **company_address** (object) - Company's address details.
  - **address_line1** (string) - First line of the address.
  - **address_line2** (string) - Second line of the address.
  - **city** (string) - City.
  - **state** (string) - State or province.
  - **postal_code** (string) - Postal code.
  - **country** (string) - Country code.

#### Response Example
```json
{
  "id": "65eb57bd-6290-431d-bf23-1cb287d7d7a8",
  "first_name": "John",
  "middle_name": "Anthony",
  "last_name": "pass",
  "native_name": "John Smith",
  "date_of_birth": "2000-09-28",
  "email": "bob@example.com",
  "mobile": "+551185249635",
  "address": {
    "address_line1": "Flat 1904",
    "address_line2": "Glass Tower",
    "city": "New York City",
    "state": "New York",
    "postal_code": "12345",
    "country": "UKR"
  },
  "gender": "MALE",
  "preferred_language": "EN",
  "place_of_birth": "USA",
  "nationality": "USA",
  "created": "2022-09-23T13:34:30.295Z",
  "modified": "2022-09-23T13:34:30.295Z",
  "country_residence": "USA",
  "country_tax_residence": "USA",
  "employment_type": "SALARIED",
  "employment_title": "string",
  "monthly_salary": 0,
  "company_name": "string",
  "company_address": {
    "address_line1": "Flat 1904",
    "address_line2": "Glass Tower",
    "city": "New York City",
    "state": "New York",
    "postal_code": "12345",
    "country": "UKR"
  }
}
```
```

--------------------------------

### Get All FX Rate Quotes Response

Source: https://docs.nymcard.com/get-started/product-management/multi-currency

This is an example response from the 'Get all FX rate quotes' API. It returns a list of FX rate quotes, including pagination details and individual quote information.

```json
{
"after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda", "has_more": true,
"data": [
{
"id": "bc121529-e6e9-45f1-b820-8c46ce7f005a", "account_id": "bc121529-e6e9-45f1-b820-8c46ce7f0058", "ts": "2020-06-08T14:57:30.123456",
"booking_ts": "2020-06-08T14:57:30.123456",
"from_currency": "AED",
"amount": 500,
"to_currency": "USD",
"to_amount": "136.15",
"exchange_rate": "0.272294"
"status": "BOOKED",
"transaction_id": "12dr4",
"fxrate_provider_id": "1",
"fxrate_provider_name": "NymCard",
"fee_amount": "1.5",
"fee_detail": [
{
"fee_id": "173427",
"description": "transaction fee",
"amount": "1.5",
"currency": "AED"
}
],
"created": "2023-02-06T10:54:02.956Z",
"modified":"2023-02-06T10:54:02.956Z"
}]
}
```

--------------------------------

### Get FX Rate Quote Details Response

Source: https://docs.nymcard.com/get-started/product-management/multi-currency

This is an example response from the 'Get a FX rate quote details' API. It provides comprehensive information about a specific FX rate quote, including currency details, amounts, exchange rates, and fees.

```json
{
"id": "bc121529-e6e9-45f1-b820-8c46ce7f005a", "account_id": "bc121529-e6e9-45f1-b820-8c46ce7f0058", "ts": "2020-06-08T14:57:30.123456",
"booking_ts": "2020-06-08T14:57:30.123456", "from_currency": "AED",
"amount": 500,
"to_currency": "USD",
"to_amount": "136.15",
"exchange_rate": "0.272294"
"status": "BOOKED",
"transaction_id": "12dr4",
"fxrate_provider_id": "1",
"fxrate_provider_name": "NymCard",
"fee_amount": "1.5",
"fee_detail": [
{
"fee_id": "173427",
"description": "transaction fee",
"amount": "1.5",
"currency": "AED"
}
],
"created": "2023-02-06T10:54:02.956Z",
"modified": "2023-02-06T10:54:02.956Z"
}
```

--------------------------------

### Create Individual User

Source: https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type

Use this example to create an INDIVIDUAL user. Ensure the 'first_name' parameter is provided. This request includes all optional fields for a comprehensive user profile.

```bash
curl --location --request POST 'https://api.dev.platform.nm-1.nymcard.com/v1/users' \
--header 'Content-Type: application/json' \
--header 'apikey: tenant1-key' \
--data-raw '{ \
  "title": "MRS", \
  "first_name": "Sara", \
  "middle_name": "Anthony", \
  "last_name": "pass", \
  "native_name": "John Smith", \
  "date_of_birth": "1989-11-07", \
  "email": "bob@example.com", \
  "mobile": "+551185249635", \
  "address": { \
    "address_line1": "Flat 1904", \
    "address_line2": "Glass Tower", \
    "city": "New York City", \
    "state": "New York", \
    "postal_code": "12345", \
    "country": "UKR" \
  }, \
  "gender": "MALE", \
  "preferred_language": "EN", \
  "place_of_birth": "USA", \
  "nationality": "USA", \
  "country_residence": "USA", \
  "country_tax_residence": "USA", \
  "employment_type": "SALARIED", \
  "employment_title": "string", \
  "monthly_salary": 0, \
  "company_name": "string", \
  "company_address": { \
    "address_line1": "Flat 1904", \
    "address_line2": "Glass Tower", \
    "city": "New York City", \
    "state": "New York", \
    "postal_code": "12345", \
    "country": "UKR" \
  }, \
  "company_country": "USA", \
  "industry_type": "I01", \
  "expected_monthly_balance": 0, \
  "user_type": "INDIVIDUAL", \
  "phone_number": "+551185249635" \
}'
```

```json
{
  "id": "95e7ffbe-0d8a-4c8d-ab84-4476c16a1494",
  "title": "MRS",
  "first_name": "Sara",
  "middle_name": "Anthony",
  "last_name": "pass",
  "native_name": "John Smith",
  "date_of_birth": "1989-11-07",
  "email": "bob@example.com",
  "mobile": "+551185249635",
  "address": {
    "address_line1": "Flat 1904",
    "address_line2": "Glass Tower",
    "city": "New York City",
    "state": "New York",
    "postal_code": "12345",
    "country": "UKR"
  },
  "gender": "MALE",
  "preferred_language": "EN",
  "place_of_birth": "USA",
  "nationality": "USA",
  "created": "2022-09-23T13:30:31.780Z",
  "modified": "2022-09-23T13:30:31.780Z",
  "country_residence": "USA",
  "country_tax_residence": "USA",
  "employment_type": "SALARIED",
  "employment_title": "string",
  "monthly_salary": 0,
  "company_name": "string",
  "company_address": {
    "address_line1": "Flat 1904",
    "address_line2": "Glass Tower",
    "city": "New York City",
    "state": "New York",
    "postal_code": "12345",
    "country": "UKR"
  },
  "company_country": "USA",
  "industry_type": "I01",
  "expected_monthly_balance": 0,
  "user_type": "INDIVIDUAL",
  "phone_number": "+551185249635",
  "status": "PENDINGIDVERIFICATION",
  "status_reason_code": "I0",
  "director_list": [],
  "signature_list": [],
  "shareholder_list": [],
  "default_user": false
}
```

--------------------------------

### Get two most recent users

Source: https://docs.nymcard.com/get-started/api-core-principles

Use the 'limit' and 'after' query parameters to control pagination. This example retrieves the two most recently created users.

```http
GET /users?limit=2&after=
```

--------------------------------

### Western Union Delivery Option Template Field Structure

Source: https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis

This example shows the raw structure of the description field for the 'Get delivery option template' API, indicating the number of fields by semicolons.

```plaintext
<DESCRIPTION>receiver.bank_account.account_holder;Account Name; 35; 1563; Account Name required; 0; UPRSTRING; NL; 35;</DESCRIPTION>
```

--------------------------------

### Get cascade list values API

Source: https://docs.nymcard.com/get-started/funding-and-transfers/western-union-apis

This API retrieves cascade list values, which vary by region. The response includes 'firstLevelValue' and 'secondLevelValue' fields that are structured based on the specific region, with an example provided for Bangladesh.

```APIDOC
## Get cascade list values API

### Description
Retrieves cascade list values, with 'firstLevelValue' and 'secondLevelValue' fields that are region-dependent.

### Method
GET

### Endpoint
/cascade-list-values

### Response
#### Success Response (200)
- **firstLevelValue** (string) - The first level of cascade list values.
- **secondLevelValue** (string) - The second level of cascade list values.

### Response Example (for Bangladesh)
```json
{
  "firstLevelValue": "value1",
  "secondLevelValue": "value2"
}
```
```

--------------------------------

### Business User Creation Response

Source: https://docs.nymcard.com/get-started/program-management/user-kyb-process

Sample response after successfully creating a business user.

```json
{
  "id": "3ba3028b-0e38-4e0b-a90e-5a8cd3dj27a5",
  "title": "MR",
  "first_name": "Alex",
  "middle_name": "Daniel",
  "last_name": "Gates",
  "native_name": "Robert Shaw",
  "date_of_birth": "2012-05-04",
  "email": "bob@example.com"
}
```

--------------------------------

### Create User

Source: https://docs.nymcard.com/get-started/program-management/user-id-verification-by-sdk

Initiates user creation. If tenant-level verification is enabled, the user status will be PENDINGIDVERIFICATION.

```APIDOC
## POST /users

### Description
Creates a new user. If `require_document_verification` is true at the tenant level, the user will be created with a status of PENDINGIDVERIFICATION.

### Method
POST

### Endpoint
/users

### Request Body
- **first_name** (string) - Required - The first name of the user.
- **middle_name** (string) - Optional - The middle name of the user.
- **last_name** (string) - Required - The last name of the user.
- **parent_user_id** (string) - Optional - The ID of the parent user, if applicable.
- **user_type** (string) - Required - The type of user (e.g., 'INDIVIDUAL').

### Request Example
```json
{
  "first_name": "John",
  "middle_name": "Anthony",
  "last_name": "Smith",
  "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  "user_type": "INDIVIDUAL"
}
```

### Response
#### Success Response (200)
Details of the created user, including their ID and status.

#### Response Example
(Refer to API Catalog for complete payload)
```

--------------------------------

### Get User Status

Source: https://docs.nymcard.com/get-started/program-management/user-id-verification-by-sdk

Retrieve the current status of a user by making a GET request to the /users/{id} endpoint.

```APIDOC
## Get User Status

### Description
This endpoint allows you to retrieve the status of a specific user identified by their ID.

### Method
GET

### Endpoint
`/users/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the user.

### Response
#### Success Response (200)
- **id** (string) - The user's unique identifier.
- **title** (string) - The user's title (e.g., MR, MS).
- **first_name** (string) - The user's first name.
- **middle_name** (string) - The user's middle name.
- **last_name** (string) - The user's last name.
- **user_type** (string) - The type of user (e.g., INDIVIDUAL).
- **status** (string) - The current status of the user (e.g., PENDINGKYC).
- **status_reason_code** (string) - A code indicating the reason for the current status.
- **kyc_policy_passed** (string) - The KYC policy that has been passed.

### Response Example
```json
{
  "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  "title": "MR",
  "first_name": "John",
  "middle_name": "Anthony",
  "last_name": "Smith",
  "user_type": "INDIVIDUAL",
  "status": "PENDINGKYC",
  "status_reason_code": "I0",
  "kyc_policy_passed": "UAE_INDIVIDUAL_PRIMARY"
}
```
```

--------------------------------

### Get a user identifications

Source: https://docs.nymcard.com/get-started/program-management/manage-documents-by-apis

Retrieve a list of user identifications by sending a GET request to the /users/{user_id}/identifications endpoint.

```APIDOC
## GET /users/{user_id}/identifications

### Description
Retrieves a list of all identifications associated with a specific user.

### Method
GET

### Endpoint
/users/{user_id}/identifications
```

--------------------------------

### Create Webhook for Charges

Source: https://docs.nymcard.com/get-started/webhooks/webhooks-samples

This example demonstrates how to create a webhook to receive notifications for charges events (CHARGE_APPLIED).

```APIDOC
## POST /webhooks

### Description
Creates a webhook notification endpoint for specific events.

### Method
POST

### Endpoint
/webhooks

### Request Body
- **endpoint** (string) - Required - The URL where webhook notifications will be sent.
- **events** (array of strings) - Required - A list of events to subscribe to. Example: ["CHARGE_APPLIED"]
- **config** (object) - Optional - Configuration for the webhook.
  - **basic_auth_username** (string) - Optional - Username for Basic Authentication.
  - **basic_auth_password** (string) - Optional - Password for Basic Authentication.
  - **custom_headers** (array of objects) - Optional - Custom headers to include in the webhook request.
    - **header_name** (string) - Required - The name of the header.
    - **header_value** (string) - Required - The value of the header.
  - **created** (string) - Optional - Timestamp of creation.
  - **modified** (string) - Optional - Timestamp of last modification.

### Request Example
```json
{
  "endpoint": "https://example.com/",
  "events": [
    "CHARGE_APPLIED"
  ],
  "config": {
    "basic_auth_username": "username",
    "basic_auth_password": "password",
    "custom_headers": [
      {
        "header_name": "apikey",
        "header_value": "306e38e4-54be-469f-beca-4297129289d6"
      }
    ],
    "created": "2022-08-24T07:01:42.185Z",
    "modified": "2022-08-24T07:01:42.185Z"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the webhook.
- **endpoint** (string) - The configured webhook endpoint URL.
- **events** (array of strings) - The list of subscribed events.
- **config** (object) - The configuration details for the webhook.

#### Response Example
```json
{
  "id": "whk_abc123xyz",
  "endpoint": "https://example.com/",
  "events": [
    "CHARGE_APPLIED"
  ],
  "config": {
    "basic_auth_username": "username",
    "basic_auth_password": "password",
    "custom_headers": [
      {
        "header_name": "apikey",
        "header_value": "306e38e4-54be-469f-beca-4297129289d6"
      }
    ],
    "created": "2022-08-24T07:01:42.185Z",
    "modified": "2022-08-24T07:01:42.185Z"
  }
}
```
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific, self-contained, and in natural language.

```HTTP
GET https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type.md?ask=<question>
```

--------------------------------

### Get Account Details API Response

Source: https://docs.nymcard.com/get-started/product-management/multi-currency

This is a sample response for the 'Get account details' API, illustrating multi-currency balances and wallet details.

```json
{
  "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  "type": "PREPAID",
  "balances": {
    "USD": 125.58,
    "EUR": 400.2
  },
  "ledger_balances": {
    "USD": 125.58,
    "EUR": 400.2
  },
  "status": "ACTIVE",
  "currencies": [
    "USD"
  ],
  "wallet_details": [
    {
      "currency": "USD",
      "priority": 0,
      "status": "ACTIVE"
    }
  ],
  "created": "2012-05-04T19:42:32.987Z",
  "modified": "2012-05-04T19:42:32.987Z"
}
```

--------------------------------

### Get Specific Order Request

Source: https://docs.nymcard.com/get-started/funding-and-transfers/external-funding-source/from-card

Retrieve a specific order by sending a GET request to the /orders/{id} endpoint, where {id} is the order ID.

```http
GET /orders/{id}
```

--------------------------------

### Perform HTTP GET Request with `ask` Parameter

Source: https://docs.nymcard.com/get-started/product-management/velocity-limits

Use this method to dynamically query the documentation. The `ask` parameter should contain a specific, self-contained question in natural language.

```http
GET https://docs.nymcard.com/get-started/product-management/velocity-limits.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.nymcard.com/get-started/funding-and-transfers/external-funding-source/from-bank-account

Use this method to query the documentation dynamically. Replace `<question>` with your specific, self-contained question in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.nymcard.com/get-started/funding-and-transfers/external-funding-source/from-bank-account.md?ask=<question>
```

--------------------------------

### Get a specific user identification

Source: https://docs.nymcard.com/get-started/program-management/manage-documents-by-apis

Retrieve specific user identification info by sending a GET request to the /users/{user_id}/identifications/{identification_id} endpoint.

```APIDOC
## GET /users/{user_id}/identifications/{identification_id}

### Description
Retrieves detailed information about a specific user identification.

### Method
GET

### Endpoint
/users/{user_id}/identifications/{identification_id}

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The ID of the user.
- **identification_id** (string) - Required - The ID of the identification to retrieve.
```

--------------------------------

### Get a specific list of allowed MCCs

Source: https://docs.nymcard.com/get-started/product-management/authorization-controls

Retrieve a specific list of allowed MCCs by its ID using a GET request to the /allowedmccs/{id} endpoint.

```APIDOC
## GET /allowedmccs/{id}

### Description
Retrieves a specific list of allowed Merchant Category Codes (MCCs) by its ID.

### Method
GET

### Endpoint
/allowedmccs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the allowed MCC list to retrieve.
```

--------------------------------

### Get a list of allowed countries by ID

Source: https://docs.nymcard.com/get-started/product-management/authorization-controls

Retrieve a specific list of allowed countries by its ID using a GET request to the /allowedcountries/{id} endpoint.

```APIDOC
## GET /allowedcountries/{id}

### Description
Retrieves a specific list of allowed countries by its unique identifier.

### Method
GET

### Endpoint
/allowedcountries/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the allowed countries list.
```

--------------------------------

### Query Documentation API

Source: https://docs.nymcard.com/get-started/program-management/user-id-verification-by-sdk

Perform an HTTP GET request to query the documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language to retrieve direct answers and relevant excerpts.

```http
GET https://docs.nymcard.com/get-started/program-management/user-id-verification-by-sdk.md?ask=<question>
```

--------------------------------

### Query Documentation API

Source: https://docs.nymcard.com/get-started/webhooks/webhooks-management

To get additional information not directly on the page, make a GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.nymcard.com/get-started/webhooks/webhooks-management.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.nymcard.com/get-started/funding-and-transfers/transfers

Use this method to dynamically query documentation when information is not explicitly present. The question should be specific and self-contained.

```http
GET https://docs.nymcard.com/get-started/funding-and-transfers/transfers.md?ask=<question>
```

--------------------------------

### Get Balance Limits Linked to Account

Source: https://docs.nymcard.com/get-started/product-management/balance-limits

Send a GET request to /accounts/{id}/balancelimits to retrieve the list of balance limits linked to a specific account.

```http
GET /accounts/{id}/balancelimits
```
Tokens:
Raw