Customer Onboarding

Endpoint to onboard a customer. The API responds with customer validation information.

Onboard a customer

POST https://api.waldo.ai/onboard

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
includeFraudCheck	Boolean	Whether to include the fraud check
ipAddress	Boolean	Customer IP address

Response

200: OK Onboarding successfully performed

{
    "validation": {
        "status": "ACCEPTED",
        "kyc": "PASSED",
        "fraudScore": 0.82,
        "warningTags": {
            "ssn": {
                "label": "SSN Integrity",
                "passed": true
            }
        },
        "kycBreakdown": {
            "identityBreakdown": {},
            "watchlistBreakdown": {}
        }
    },
    "externalId": "abcd-123-456-efgh",
    "customerId": "<customer-id>",
    "uri": "https://app.waldo.ai/customers/<customer-id>"
}

400: Bad Request Missing customer data

{ 
  "code": "MISSING_DATA",
  "message": "Missing customer data."
}

400: Bad Request Invalid data format (birthdate, email, state)

{ 
  "code": "INVALID_DATA",
  "message": "Invalid <field name>"
}

401: Unauthorized Invalid token

{
  "code": "INVALID_TOKEN", 
  "message": "Invalid token."
}

403: Forbidden Authorization header missing

{ 
  "code": "NOT_AUTHORIZED",
  "message": "Not authorized."
}

403: Forbidden Service or user not authorized

{ 
  "code": "NOT_AUTHORIZED",
  "message": "You are not authorized to perform this action. Please contact support for assistance."
}

403: Forbidden Inactive API key

{ 
  "code": "API_KEY_REVOKED",
  "message": "This API key has been revoked. Please visit the Waldo AI dashboard to review your API key."
}