Endpoint to onboard a customer. The API responds with customer validation information.
Onboard a customer
POSThttps://api.waldo.ai/onboard
All evaluation requests are asynchronous. Onboarding a customer includes a kyc or fraud evaluation.
Therefore, the response to the onboarding request will not be completed in real time.
If you have set up the webhooks, your system will receive notifications automatically.
Otherwise, your system can poll Waldo's API until the evaluation is completed.
Headers
Name
Type
Description
Authorization*
String
The token obtained in the authentication request in the format Bearer eyJhbG...
Content-Type*
String
Expected type is application/json
Request Body
Name
Type
Description
firstName*
String
Customer's first name
lastName*
String
Customer's last name
officialId*
Object
Customer ID in format {"docType": "SSN", "value": "123-45-6789", "country": "US"}
email*
String
Customer's e-mail address
phone*
String
Customer's phone number
dob*
String
Birthdate in format yyyy-MM-dd
address*
String
Customer's address
state*
String
Customer's state (abbreviated) in format NY
zipCode*
String
Customer's postal code
entityId
String
Customer ID in your database
city*
String
Customer's city
country*
String
Customer's country
options
Object
Optional parameters.
ipAddress
Boolean
Customer IP address
Options
Name
Type
Description
includeFraudCheck
Boolean
Set includeFraudCheck parameter to true to include the fraud check
useExpressKYC
Boolean
Set useExpressKYC parameter to true to obtain the preliminary KYC evaluation
