End Users are your users who should be created on Fiat Republic before you can start receiving or sending payments for them. We require a minimum set of details on your customers to fulfil our regulatory obligations and perform AML checks.
Activation of a new Individual End User is fully asynchronous. This means that after a POST request the returned entity won't be with ACTIVE Status immediately, but CREATED.
To enable USD for End Users, please find requirements gathered here Enabling USD Services
Check Guides for more details here
Individual End User Object
| Attribute | Description | Format / ENUMS |
|---|---|---|
| id string | Unique identifier of the End User. | e.g. eus_j82rl497g47g5ykvzn |
| person.firstName string | First name of the End User. | Can be built of multiple space separated segments. Must have only letters, hyphens and apostrophes. Regex: ^[a-zA-Z](?:[a-zA-Z '.-]*[a-zA-Z])?\.?$ |
| person.middleName string | Middle names of the End User | Can be built of multiple space separated segments. Should be between 1 and 100 characters long and contain only letters, hyphens, dots and apostrophes. Regex: ^[a-zA-Z](?:[a-zA-Z '.-]*[a-zA-Z])?\.?$ |
| person.lastName string | Last name of the End User. | Can be built of multiple space separated segments. Must consist of words that have only letters, hyphens and apostrophes. Regex: ^'?[a-zA-Z]([ a-zA-Z'-]*[a-zA-Z])?$ |
| person.address.line1 string | First line of the End User home address. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,)(⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(⁰°#"]*$ |
| person.address.line2 string | Second line of the End User's home address. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,)(⁰°#"]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(⁰°#"]*$ |
| person.address.city string | City of the End User. | Space and hyphen are allowed between the characters. Max length 50 Regex: ^[a-zA-Z0-9 .'\-/,]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,]*$ |
| person.address.state string | Region or state of the End User. | Space and hyphen are allowed between the characters. Max length 35 Regex: ^[a-zA-Z0-9 .'\-/,)(+]*[a-zA-Z0-9]+[a-zA-Z0-9 .'\-/,)(+]*$ |
| person.address.postalCode string | Postal/Zip code of the End User. | Validation regex: - for GB: ^[a-zA-Z]{1,2}[0-9R][0-9a-zA-Z]? ?[0-9][a-zA-Z]{2}$- for Estonia: ^\d{5}$- for Ireland: (?:[AC-FHKNPRTV-Y][0-9]{2}|D6W)[ -]?[0-9AC-FHKNPRTV-Y]{4}$- others: ^[a-zA-Z\d][a-zA-Z\s\d\-]{1,8}[a-zA-Z\d]$ |
| person.address.country string | End User's Country of residence. Once provided, cannot be changed. | Two-letter ISO 3166-1 alpha-2 country code e.g. GB or US |
| person.email string | Email address of the End User. | |
| person.phone string | Phone number of the End User. | Including the country prefix e.g. +447788661100- must start with a plus sign (+). - should have country code (e.g., +1, +44, etc.) followed by the appropriate number of digits (min = 8, max = 15) |
| person.birthCountry string | Country of birth of the End User. | Two-letter ISO 3166-1 alpha-2 country code e.g. FR or CA |
| person.nationality array of strings | One or more nationalities of the End User. | Two-letter ISO 3166-1 alpha-2 country code e.g. AU or BE |
| person.identificationDocument.number | Number of identity document | |
| person.identificationDocument.type | Type of identity document | Examples:WORK_PERMIT,PASSPORT,NATIONAL_ID,DRIVERS_LICENCE |
| person.dob date | Date of birth of the End User. | YYYY-MM-DD format e.g. 1975-04-05 |
| ipAddress string | The IP address from where the individual signed up on your platform. | e.g. 86.23.22.163 |
| annualSalaryRange string | Value of annual salary of the Individual End User (in EUR) | Ranges: - 0 to 25000 - 25000 to 50000 - 50000 to 100000 - 100000 to 150000 - above 150000 |
| tags array of strings | Tags allowing you to provide additional risk-related information for the individual. | PEP |
| status string | Status of the End User. | CREATED , IN_REVIEW,ACTIVE, SUSPENDED,REJECTED, CLOSED |
| createdAt integer | Epoch Timestamp at which the object was created. | e.g. 1637049210552 |
| updatedAt integer | Epoch Timestamp at which the object was last updated. | e.g. 1637049210552 |
| metadata array of strings | Additional data in JSON key:value format. | See Metadata for more information |
| linkedCryptoWallets array of objects | Details of any known crypto wallets linked with the individual being created. | |
| linkedCryptoWallets.coin string | Symbol of the coin or token. | e.g. BTC |
| linkedCryptoWallets.walletAddress string | Blockchain wallet address of the coin or token. | e.g 3d1f7363-f6b3-1705-le5c-e4dfc7k8192n |
| linkedCryptoWallets.relationship array of strings | One or more relationships between the individual and the walletAddress. | OWN, SENDER or RECEIVER |
| riskRating string | Rating of the risk level assigned to the user. | LOW, MEDIUM, HIGH |
| signupAt integer | A date of registration of End User profile within Member platform | e.g. 1637049210552 |
After creating an Individual End User, you will be able to create one or more Virtual Accounts for them.