Customers can be businesses, accredited investors or individuals. Customers have 1 or more Accounts. Customers are created through the onboarding process.
Customers cannot be created directly. Instead you must onboard customers through the application process.
An Application collects Know Your Business (KYB) and/or Know Your Customer (KYC) data on the customer. This data is validated, approved by Rail and its relevant partners to ensure compliance with regulatory requirements.
Once the KYB, KYC information is validated and approved, the customer and a default Account are created in Rail.
To get details on a specific customer, use the customers/{customer_id} endpoint
You can retrieve all the customers using the customers endpoint. You can provide filter criteria in the query parameters such as type and status.
Customers cannot be updated directly. If changes are needed please contact support via the support desk.
The customer status will determine how it can be used.
Each status enforces rules as to what actions can be performed on a customer.
Read- is the customer information visible.Update- can the customer information / status be updated.Transact- can a customer send/receive funds.
A customer is limited by what status it can be set to based on their current status. E.g. a customer in FROZEN cannot be set to PENDING.
| Status | Description | Rules | Possible Next Status |
|---|---|---|---|
ACTIVE | Customer is fully operational. | ✅ Read ✅ Update ✅ Transact | EDD, DORMANT, CLOSED, FROZEN |
CLOSED | Customer is not operational. A customer cannot be updated from Closed status. | ✅ Read 🚫 Update 🚫 Transact | No possible next status |
EDD | Customer requires enhanced due dilligence. Customer is still operational. | ✅ Read ✅ Update ✅ Transact | ACTIVE, CLOSED, FROZEN |
PENDING | Customer is being AML checked. | ✅ Read ✅ Update 🚫 Transact | ACTIVE, CLOSED |
FROZEN | Customer is not operational until due dilligence checks are made. | ✅ Read ✅ Update 🚫 Transact | ACTIVE, CLOSED, EDD |
DORMANT | Customer is operational but has not been used in 12 months. | ✅ Read ✅ Update ✅ Transact | ACTIVE, CLOSED, EDD |
Statuses may have 'l2f' after the status e.g. PENDING_L2F. This means that the customer requires action by Rail. Customers in these statuses can only be updated by Rail.