AboutOwlPayOwlTing
API Reference
Contact Us
  1. OwlPay Harbor API
  2. Onboarding (Graded V2)

Start graded verification

post
https://harbor-sandbox.owlpay.com/api/v2/customers//individual/onboarding

Submits the complete KYC data for the requested level (1 or 2) and processes it
asynchronously; the response is the customer's verification standing, the same shape
every endpoint in this group answers. Level 1 is only available when the residence
country is the US. Level 3 cannot be applied for directly: complete level 2, then
apply through the upgrade endpoint. Track progress via the GET endpoint or
customer_onboarding.* webhooks; the approved level itself is announced by
customer.kyc_level.changed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
integer
enum
required

Verification level to apply for. Possible values: 1, 2. Which of the fields below are required follows from this number: level 1 collects a residence state only (US residents); level 2 collects the full KYC set.

Allowed:
string | null

ISO 3166-1 alpha-2 nationality. Required at every level. Must be 2 characters.

residence
object | null

Residence address.

string | null

(kyc_level 2) Social Security Number, 9 digits. Required for a residence in the United States; not accepted otherwise (send tax_id). Must match the regex /^[0-9]{9}$/.

string | null

(kyc_level 2) Local tax identification number (TIN). Required for a residence outside the United States; not accepted otherwise (send ssn). Must not be greater than 64 characters.

string | null

(kyc_level 2) Occupation slug. Fetch the list from GET /api/v2/customers/individual/occupations. Must not be greater than 64 characters.

purpose_of_use
array of strings

A purpose of use value.

purpose_of_use
Allowed:
string | null

(kyc_level 2) Free-text description of the purpose of use. Required if purpose_of_use includes other. Must not be greater than 255 characters.

string | null

ISO 3166-1 alpha-2 country code of the phone number. Required for a residence in the United States when the customer record has no phone number. Must be 2 characters.

string | null

Phone number. Required for a residence in the United States when the customer record has no phone number. Must not be greater than 20 characters.

identity_document
object | null

(kyc_level 2) Identity document.

Headers
string
Responses

Updated 43 minutes ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 43 minutes ago

Did this page help you?