PENDING - A customer in the PENDING state is present on the system, but is not yet ENABLED. Use this state when you wish to add a customer to the system, but don't want them to interact with it straight away.
ENABLED - The customer has been created and can start transacting if the required level of due diligence has been achieved.
DISABLED - The customer is temporarily disabled and cannot make any debit transactions from their account. e.g Withdrawals
LOCKED - The customer has been locked by Paybase and cannot transact until enabled again by Paybase.
CLOSING - The customer has been flagged for closing by Paybase and will be terminated within 90 days. Only withdrawals to an existing bankAaccount can be processed in this state.
TERMINATED - The customer has been terminated by Paybase and cannot interact with the system or trasition to another state.
annotations object<string, string>
A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.
An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.
The timestamp in UTC at which the Terms were accepted.
Version name or number of the Terms that were accepted.
The level of customer due diligence achieved by this customer.
ZERO, ONE, TWO, THREE, FOUR, FIVE
Due diligence checks are performed asynchronously by our system. Therefore, at creation the cddLevel of a customer might be ZERO but will automatically increase as checks are processed by our system. In some instances, an automated check might fail and you will be required to provided additional information for the customer.
You can use to customer_cdd_level_changed webhook to get notified on changes in the cddLevel of a customer or the check_failed webhook for notifications on failed checks.
The targetCDDLevel for a customer depends on their role and is the level to which our system will attempt to verify a customer. The information required for each level differs and would have been provided to you at the time of onboarding.
ZERO, ONE, TWO, THREE, FOUR, FIVE
The full company registration number as it appears on the relevant register.
A list of business persons associated with the customer.
The unique identifier of the role associated with the customer.
The full registered name of the company as it appears on the relevant register (such as Companies House in the UK).
The trading name of the company if differnt from the registeredName.
The email address of the customer.
The phone number of the customer including country code with a 00 or + prefix.
e.g 00447712345678 or +447712345678 for a UK phone number
The industry in which the business operates. You do not have to provide this as we will automatically fetch and return the industry based on the companyNumber.
The URL for the business website, including the http/s scheme.
A description of the incorporated business and its legal holding structure. Depending on the target due diligence level set for your customers, we will need to understand who the beneficial owners of the business are. You can also upload a document on the customer profile with this information.
Date of incoporation of the business, in UTC.
Input Date Formats
Milliseconds since Unix epoch e.g. for 31st January 1970 provide 2592000000