Create Application - Sole Prop. Card Present

Create an application for a sole proprietorship that requires a physical card for their transactions. This is usually a brick and mortar business.

Parameters

Request Header Parameters

- access_key
- Unique access key provided by Rapyd for each authorized user.
  See Developers.
- Content-Type
- Indicates that the data appears in JSON format. Set to application/json.
- idempotency
- A unique key that prevents the platform from creating the same object twice.
  See Idempotency.
- salt
- Random string. Recommended length: 8-16 characters.
- signature
- Signature calculated for each request individually.
  See Request Signatures.
- timestamp
- Timestamp for the request, in Unix time (seconds).
- merchant_account_id
- The merchant account ID that was provided to you when you created the organization. See also Create Organization.

Request Body Parameters

- business_industry
- The 4 digit MCC code of the industry. See also List Industries.

- ewallet_token
- Identifier of the merchant's wallet. String starting with _ewallet.

- merchant_phone_number
- Phone number details of the merchant.
  phone_country_code
  The two-letter ISO 3166-1 ALPHA-2 code for the country of the phone number.
  phone_number
  The phone number of the merchant without the international phone code.

- sections
- An object that consists of the sections of the application.
  business
  Business-related information section.
  trade_name
  The trading name object.
  trade_name
  The trading name under which the business operates.
  product_description
  Object for description of products or services.
  business_desc
  A brief description of business activities.
  proof_of_address_document
  Reference to proof-of-address document object.
  address_ref
  Identifier for the address proof document.
  url
  URL object.
  business_url
  The URL of the business’s website.
  transaction_information
  Transaction volume and revenue details.
  avg_tpv_usd
  Average transaction amount in USD.
  expectedMaximumTransactionAmount
  Expected maximum single transaction amount in USD.
  averageTimeBetweenPurchaseAndDeliveryInDays
  Average days between purchase and delivery.
  annual_revenue
  Annual revenue in USD.
  statement_descriptor
  Statement descriptor object.
  statement_descriptor
  The text that appears on a customer's bank or credit card statement to identify a transaction of this business. Enter a value of 5 to 22 alphanumeric characters and spaces.
  proof_of_address
  Physical business address details.
  physical_address
  Street address of the business.
  address_additional_details
  Any additional address details.
  postal_code
  Postal code of the address.
  city
  City of the address.
  state
  State or region, if applicable.
  country
  ISO 3166-1 alpha-2 country code.
  company
  Company-related information section.
  business_name
  Registered business name object.
  business_name
  The business name.
  phone
  Company contact phone details.
  phone_country_code
  ISO 3166-1 alpha-2 country code.
  phone_number
  Company phone number without prefix.
  company_number
  Company registration details.
  registration_number
  Registration number assigned by registrar.
  address
  Registered company address.
  address
  Street address.
  address_additional_details
  Extra address details.
  postal_code
  Postal code.
  city
  City.
  state
  State or region.
  us_state
  US state, if applicable.
  country
  ISO 3166-1 alpha-2 country code.
  vat_id
  VAT identifier.
  tax_id
  VAT or tax identification number.
  company_documents
  Uploaded company document references.
  company_documents
  List of document identifiers.
  owner
  Owner-related information section.
  name
  Owner’s name details.
  first_name
  First name.
  last_name
  Last name.
  dob
  Owner’s date of birth.
  dob
  Date of birth in DD/MM/YYYY format.
  address
  Owner’s residential address.
  address
  Street address.
  address_additional_details
  Extra address details.
  postal_code
  Postal code.
  city
  City.
  state
  State or region.
  us_state
  US state, if applicable.
  country
  ISO 3166-1 alpha-2 country code.
  email
  Email address of the owner.
  email
  Email address.
  nationality
  Owner’s nationality details.
  nationality
  ISO 3166-1 alpha-2 nationality code.
  additional_citizenships
  Additional nationality codes separated by comma. For example ["IT","FR"]
  phone
  Owner’s phone details.
  phone_country_code
  ISO 3166-1 alpha-2 country code.
  phone_number
  Phone number without prefix.
  proof_of_address_document
  Owner’s address proof reference.
  address_ref
  Identifier for address proof document.
  identification
  Owner’s government identification.
  id_type
  Type of identification (e.g. Driver’s License).
  id
  Government-issued ID number.
  id_img
  Reference to uploaded ID image (Front side).
  government_id_img
  Reference to the scan file of the back of the government-issued ID.

Each section includes unique fields that can be filled out via this method or the Update Application method. For more information on the valid values of each field see Get Application Template.

Response

- token
- Identifier of the application. String starting with app_.

- version
- The version number of the application. The version is incremented by 1 each time it is updated.

- status
- The following statuses of the application are available:
  - New: Application was created but not yet submitted.
  - Submitted: Application has been submitted. All required fields were completed.
  - Pending Review: An application is waiting in the queue to be reviewed.
  - In Review: An application is being reviewed by a CompOps Analyst.
  - Approved: Application has been approved, either manually or automatically.
  - Limited Approval: Application was approved with limits, either manually or automatically.
  - Rejected: Application was rejected, either manually or automatically.
  - BACKLOG: If there is a technical issue, then the application is in backlog status, and an attempt to rerun the application will be made when the technical issue is resolved.

- metadata
- A JSON object defined by the client. See Metadata

- entity_type
- The type of entity:
  - Sole Proprietor Card Present
  - Sole Proprietor Card Not Present
  - Non-Sole Proprietor Card Present
  - Non-Sole Proprietor Card Not Present

- country
- The two letter country code of the entity. Uppercase.

- created_at
- Time of creation of the object, in Unix time.

- updated_at
- Time of the last update of the object, in Unix time.

- sell_type
- The description of the sell type. See also List Industries
  - Card Present - Physical Business (Brick and Mortar)
  - Card Not Present - Website with a Checkout Page

- business_industry
- Four digit merchant category code of the business industry. See also List Industries

- merchant_phone_number
- Phone number details of the merchant.
  phone_country_code
  The two-letter ISO 3166-1 ALPHA-2 code for the country of the phone number.
  phone_number
  The phone number of the merchant without the international phone code.

- sections
- Includes the sections of the application with the current field values.
  business
  Business-related information section.
  trade_name
  The trading name object.
  trade_name
  The trading name under which the business operates.
  product_description
  Object for description of products or services.
  business_desc
  A brief description of business activities.
  url
  URL object.
  business_url
  The URL of the business’s website.
  transaction_information
  Transaction volume and revenue details.
  avg_tpv_usd
  Average transaction amount in USD.
  expectedMaximumTransactionAmount
  Expected maximum single transaction amount in USD.
  averageTimeBetweenPurchaseAndDeliveryInDays
  Average days between purchase and delivery.
  annual_revenue
  Annual revenue in USD.
  statement_descriptor
  Statement descriptor object.
  statement_descriptor
  The text that appears on a customer's bank or credit card statement to identify a transaction of this business. Enter a value of 5 to 22 alphanumeric characters and spaces.
  company
  Company-related information section.
  business_name
  Registered business name object.
  business_name
  The business name.
  phone
  Company contact phone details.
  phone_country_code
  ISO 3166-1 alpha-2 country code.
  phone_number
  Company phone number without prefix.
  company_number
  Company registration details.
  registration_number
  Registration number assigned by registrar.
  address
  Registered company address.
  address
  Street address.
  address_additional_details
  Extra address details.
  postal_code
  Postal code.
  city
  City.
  state
  State or region.
  us_state
  US state, if applicable.
  country
  ISO 3166-1 alpha-2 country code.
  vat_id
  VAT identifier.
  tax_id
  VAT or tax identification number.
  company_documents
  Uploaded company document references.
  company_documents
  List of document identifiers.
  owner
  Owner-related information section.
  name
  Owner’s name details.
  first_name
  First name.
  last_name
  Last name.
  dob
  Owner’s date of birth.
  dob
  Date of birth in DD/MM/YYYY format.
  address
  Owner’s residential address.
  address
  Street address.
  address_additional_details
  Extra address details.
  postal_code
  Postal code.
  city
  City.
  state
  State or region.
  us_state
  US state, if applicable.
  country
  ISO 3166-1 alpha-2 country code.
  email
  Email address of the owner.
  email
  Email address.
  nationality
  Owner’s nationality details.
  nationality
  ISO 3166-1 alpha-2 nationality code.
  additional_citizenships
  Additional nationality codes separated by comma. For example ["IT","FR"]
  phone
  Owner’s phone details.
  phone_country_code
  ISO 3166-1 alpha-2 country code.
  phone_number
  Phone number without prefix.
  proof_of_address_document
  Owner’s address proof reference.
  address_ref
  Identifier for address proof document.
  identification
  Owner’s government identification.
  id_type
  Type of identification (e.g. Driver’s License).
  id
  Government-issued ID number.
  id_img
  Reference to uploaded ID image (Front side).
  government_id_img
  Reference to the scan file of the back of the government-issued ID.

Each section includes unique required and optional fields. A field includes the issues object in cases where its value is missing or is invalid. The issues object includes the fieldname and the details for providing the correct value. For example, if an invalid value is provided for the business_name field, then details are "Enter a value of up to 80 alphanumeric characters and spaces."

If a required field value is entered correctly then the field displays its current value and it has no issues object.

- instructions
- Includes the instructions on how to fill out the application. Certain industry types enable filling out the application via the APIs and a link to hosted page. However, there are industry types that do not enable filling out the application via API methods and require filling it out via a hosted page link. In such scenarios the application is not returned and the following instructions are displayed: "The industry type for this application must filled out online. "
- link
- Link to a hosted page where the application can be filled out online.

/v1/partner/onboarding/application/sole_prop_card_present

Create Application - Sole Prop. Card Present

curl -X post 'https://api.rapyd.net/v1//partner/onboarding/application/sole_prop_card_present' \
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'idempotency: your-idempotency-parameter-here' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here' \
-H 'merchant_account_id: your-merchant-account-here' \
--data-raw '{
    "ewallet_token": "ewallet_527f7a2422ec8a2925f8a37e3f626db7",
    "merchant_phone_number": {
        "country_code": "GB",
        "phone_number": "5555555555"
    },
    "business_industry": "4814",
    "sections": {
        "business": {
            "trade_name": {
                "trade_name": "Trade Sample Limited"
            },
            "product_description": {
                "business_desc": "Trading samples"
            },
            "proof_of_address_document": {
                "address_ref": ""
            },
            "url": {
                "business_url": ""
            },
            "transaction_information": {
                "avg_tpv_usd": 10,
                "expectedMaximumTransactionAmount": 20,
                "averageTimeBetweenPurchaseAndDeliveryInDays": 30,
                "annual_revenue": 400000
            },
            "statement_descriptor": {
                "statement_descriptor": "statement descriptor is not defined"
            },
            "proof_of_address": {
                "physical_address": "Mainland street 1",
                "address_additional_details": "",
                "postal_code": "0AA",
                "city": "Anytown",
                "country": "GB",
                "state": ""
            }
        },
        "company": {
            "business_name": {
                "business_name": "Trade PVT Limited"
            },
            "phone": {
                "phone_country_code": "GB",
                "phone_number": "2071234567"
            },
            "company_number": {
                "registration_number": "OC123456"
            },
            "address": {
                "address": "Oasis street 12",
                "postal_code": "SW1A 0AA",
                "city": "Anytown",
                "country": "GB",
                "state": "",
                "address_additional_details": "",
                "us_state": ""
            },
            "vat_id": {
                "tax_id": ""
            }
        },
        "owner": {
            "name": {
                "first_name": "Joe",
                "last_name": "Smith"
            },
            "dob": {
                "dob": "12/12/1991"
            },
            "address": {
                "address": "Mainland building",
                "postal_code": "SW1A 0AA",
                "city": "Anytown",
                "country": "GB",
                "state": "",
                "address_additional_details": "address additional input",
                "us_state": null
            },
            "email": {
                "email": "tradepvtl@emailsample.com"
            },
            "nationality": {
                "nationality": "IT",
                "additional_citizenships": [
                    "FR",
                    "DE"
                ]
            },
            "proof_of_address_document": {
                "address_ref": ""
            },
            "phone": {
                "phone_country_code": "GB",
                "phone_number": "5555555555"
            },
            "identification": {
                "id_type": "Driver's License",
                "id": "ID-63773",
                "id_img": "",
                "government_id_img": null
            }
        }
    }
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "Success",
        "response_code": "",
        "operation_id": "972495e2-d4bb-4fc4-9e2a-061f5ada1d12"
    },
    "data": {
        "token": "app_790a5db172024bc29a705416d70f9225",
        "version": 2,
        "status": "NEW",
        "ewallet_token": "ewallet_527f7a2422ec8a2925f8a37e3f626db7",
        "metadata": {},
        "entity_type": "Sole_Proprietor",
        "country": "GB",
        "created_at": 1750840363974,
        "updated_at": 1750840364440,
        "sell_type": "Physical Business (Brick and Mortar)",
        "business_industry": 4814,
        "sections": {
            "business": {
                "trade_name": {
                    "trade_name": "trade PVT Limited"
                },
                "product_description": {
                    "business_desc": "Trading in and out"
                },
                "url": {
                    "business_url": ""
                },
                "transaction_information": {
                    "avg_tpv_usd": "10",
                    "expectedMaximumTransactionAmount": "20",
                    "averageTimeBetweenPurchaseAndDeliveryInDays": "30",
                    "annual_revenue": "400000"
                },
                "statement_descriptor": {
                    "issues": [
                        {
                            "field": "statement_descriptor",
                            "details": "Enter a value of 5 to 22 alphanumeric characters and spaces."
                        }
                    ]
                },
                "proof_of_address_document": {
                    "issues": [
                        {
                            "field": "address_ref",
                            "details": "This file is required."
                        }
                    ]
                },
                "proof_of_address": {
                    "physical_address": "Mainland street 1",
                    "address_additional_details": null,
                    "postal_code": "0AA",
                    "city": "Anytown",
                    "state": null,
                    "country": "GB"
                }
            },
            "company": {
                "business_name": {
                    "business_name": "Trade PVT Limited"
                },
                "phone": {
                    "phone_country_code": "GB",
                    "phone_number": "5555555555"
                },
                "company_number": {
                    "registration_number": "OC123456"
                },
                "address": {
                    "address": "Oasis street 12",
                    "address_additional_details": null,
                    "postal_code": "SW1A 0AA",
                    "city": "Anytown",
                    "state": null,
                    "us_state": null,
                    "country": "GB"
                },
                "company_documents": {
                    "company_documents": []
                },
                "vat_id": {
                    "tax_id": null
                }
            },
            "owner": {
                "name": {
                    "first_name": "Joe",
                    "last_name": "Smith"
                },
                "dob": {
                    "dob": "12/12/1991"
                },
                "identification": {
                    "id_type": "Driver's License",
                    "id": "ID-63773",
                    "government_id_img": [],
                    "issues": [
                        {
                            "field": "id_img",
                            "details": "This file is required."
                        }
                    ]
                },
                "phone": {
                    "phone_country_code": "GB",
                    "phone_number": "5555555555"
                },
                "email": {
                    "email": "tradepvtl@emailsample.com"
                },
                "nationality": {
                    "nationality": "IT",
                    "additional_citizenships": [
                        "FR",
                        "DE"
                    ]
                },
                "address": {
                    "address": "Mainland building",
                    "address_additional_details": "address additional input",
                    "postal_code": "SW1A 0AA",
                    "city": "Anytown",
                    "state": null,
                    "us_state": null,
                    "country": "GB"
                },
                "proof_of_address_document": {
                    "issues": [
                        {
                            "field": "address_ref",
                            "details": "This file is required."
                        }
                    ]
                }
            }
        },
        "link": "https://qaverify.rapyd.net/verify?token=happ_99ba77b91ee54e6d8d5590853d226a75",
        "merchant_phone_number": {
            "country_code": "GB",
            "phone_number": "2071234567"
        },
        "instructions": "An application for this industry type can be filled out via the related API methods or via the hosted page 'link' that appears at the end of this response."
    }
}

Create Application - Sole Prop. Card Present - Must be Filled Out Online

curl -X post 'https://api.rapyd.net/v1/partner/onboarding/application/sole_prop_card_present' \
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'idempotency: your-idempotency-parameter-here' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here' \
-H 'merchant_account_id: your-merchant-account-here' \
--data-raw '{
"ewallet_token": "ewallet_e5ca0107316048e7edca3fa05e679886",
    "merchant_phone_number": {
        "country_code": "FI",
        "phone_number": "1231234"
    },
    "business_industry": "7995"
}'

                   
{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "Success",
        "response_code": "",
        "operation_id": "bc64d6aa-f8e5-4745-996c-634c7a04997e"
    },
    "data": {
        "token": "app_df958f58040d4750b26274ac8b0d1766",
        "version": 1,
        "status": "NEW",
        "ewallet_token": "ewallet_e5ca0107316048e7edca3fa05e679886",
        "metadata": null,
        "entity_type": null,
        "country": null,
        "created_at": null,
        "updated_at": null,
        "sell_type": null,
        "business_industry": null,
        "sections": null,
        "merchant_phone_number": null,
        "instructions": "An application for this industry type must be filled out online via the hosted page 'link' that appears at the end of this response.",
        "link": "https://qaverify.rapyd.net/verify?token=happ_fc6bfd1c8da74b6cb1b6e585650b1454"
    }
}

In this section:

Documentation

Create Application - Sole Prop. Card Present

Parameters

Request Header Parameters

Request Body Parameters

Response

Search results