Create EUR Account


This endpoint enables a new business user to complete onboarding by submitting company details, addresses, and key personnel information. It accepts structured form data including business registration information, trading and registered addresses, and details of associated persons (such as directors or UBOs). On successful onboarding, the API responds with the newly registered user's details along with an access token for authenticated requests.

Method API Endpoint
POST https://efylink-business.rare-able.com/api/user/onboarding

headers: Object containing the API headers.

'Authorization : Bearer Token': Use Login API for access token

'X-CLIENT-ID': Use Get Credentials api to generate X-CLIENT-ID

'X-Api-Signature': To know how to generate please use Authentication

'X-Api-Timestamp': Timestamp

Body Params

business.companyName required Regex: /^[a-zA-Z0-9\s',£€¥':\/«»\"".\?\-\+\(\)]+$/

business.country_code optional Please use isd_code from Lookups for Country codes

business.phone optional

business.tradingName required Regex: /^[a-zA-Z0-9\s',£€¥':\/«»\"".\?\-\+\(\)]+$/

business.registrationNumber required string

business.registrationDate required format: Y-m-d

business.website optional Valid website URL

business.registeredAddress_line1 required max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)]*$/

business.registeredAddress_line2 optional max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)]*$/

business.registeredAddress_city required max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)]*$/

business.registeredAddress_state required max:35, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\+]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\+]*$/

business.registeredAddress_postalCode required string

business.registeredAddress_country required ISO 2-letter code | Please use alpha_2_code from Lookups for Countries

business.tradingAddress_line1 required max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*$/

business.tradingAddress_line2 optional max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*$/

business.tradingAddress_city required max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)]*$/

business.tradingAddress_state required max:35, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\+]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\+]*$/

business.tradingAddress_postalCode required

business.tradingAddress_country required ISO 2-letter code | Please use alpha_2_code from Lookups for Countries

business.ipAddress required valid IP address

business_persons required Array of persons

business_persons.*.dob required format: Y-m-d, must be 18+

business_persons.*.email required Valid email address

business_persons.*.country_code optional Please use isd_code from Lookups for Country codes

business_persons.*.phone optional Regex: /^\+[1-9]\d{7,14}$/

business_persons.*.types.* required Enum: 'DIRECTOR', 'UBO', 'CONTACT' | Both DIRECTORS and UBO have to be provided

business_persons.*.ownership required required if UBO, numeric between 0-100

business_persons.*.firstName required Regex: /^[a-zA-Z](?:[a-zA-Z '\.\-]*[a-zA-Z])?\.?$/

business_persons.*.middleName optional Regex: /^[a-zA-Z](?:[a-zA-Z '\.\-]*[a-zA-Z])?\.?$/, min:1, max:100

business_persons.*.lastName required Regex: /^'?([a-zA-Z][ a-zA-Z'-]*)$/

business_persons.*.birthCountry optional ISO 2-letter | Please use alpha_2_code from Lookups for Countries

business_persons.*.nationality optional array of ISO 2-letter codes | Please use Lookups for Countries | Required if USD Payee

business_persons.*.address_line1 required max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*$/

business_persons.*.address_line2 optional max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\⁰°#"]*$/

business_persons.*.address_city required max:50, regex: /^[a-zA-Z0-9 .\'\-\/,\)]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)]*$/

business_persons.*.address_state required max:35, regex: /^[a-zA-Z0-9 .\'\-\/,\)\(\+]*[a-zA-Z0-9]+[a-zA-Z0-9 .\'\-\/,\)\(\+]*$/

business_persons.*.address_postalCode required

business_persons.*.address_country required ISO 2-letter | Please use alpha_2_code from Lookups for Countries

annualTurnoverRange optional Enum: ['RANGE_1_TO_50000', 'RANGE_50000_TO_250000', 'RANGE_250000_TO_1000000', 'RANGE_1000000_TO_5000000', 'ABOVE_5000000']

sector required string | Please use Sectors for sectors