Create customer onboarding link
create_customer_onboarding_linkDestructive
Create a customer and generate a hosted verification link for self-service KYC/KYB, reusing existing customers by email.
Instructions
Create a customer and get a hosted verification link for them in one call, so the customer enters their own KYC/KYB details. An existing customer with the same email is reused (customer_created is false) and the fields sent are ignored. Takes the same fields as create_customer; send what you already know.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"customerType": "<customerType>"
},
"name": "create_customer_onboarding_link"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dob | No | Date of birth in YYYY-MM-DD format (e.g., '1990-01-15') | |
| type | No | Company type (e.g., 'Private Company Limited by Shares') | |
| No | Customer's email address | ||
| phone | No | Phone number with country code (e.g., '+14155552671') | |
| taxId | No | Tax ID (e.g., '12-3456789') | |
| country | No | Country code ISO 3166-1 alpha-2 (required for businesses, e.g., 'US') | |
| website | No | Website URL | |
| lastName | No | Last name (required for individuals) | |
| firstName | No | First name (required for individuals) | |
| rejectUrl | No | Where to send the customer if verification is rejected | |
| ttlInSecs | No | Link lifetime in seconds (default 1800) | |
| middleName | No | Middle name | |
| successUrl | No | Where to send the customer after verification succeeds | |
| acceptTerms | No | Accept Stables' terms of service and privacy policy | |
| addressCity | No | City | |
| companyName | No | Company name (required for businesses) | |
| nationality | No | Two-letter country code (e.g., 'US', 'GB') | |
| addressLine1 | No | Street address line 1 | |
| addressLine2 | No | Street address line 2 | |
| addressState | No | State or region | |
| customerType | Yes | Type of customer - 'individual' for personal, 'business' for companies | |
| entitlements | No | List of entitlements to request | |
| sourceOfFunds | No | Source of funds | |
| accountPurpose | No | What will you use Stables for? | |
| addressCountry | No | Two-letter country code (e.g., 'US') | |
| incorporatedOn | No | Date of incorporation in YYYY-MM-DD format | |
| describeBusiness | No | Description of the business | |
| legalAddressCity | No | Legal address city (for businesses) | |
| verificationType | No | Run one verification step instead of the full flow | |
| addressPostalCode | No | Postal/ZIP code | |
| legalAddressLine1 | No | Legal address line 1 (for businesses) | |
| legalAddressLine2 | No | Legal address line 2 (for businesses) | |
| legalAddressState | No | Legal address state (for businesses) | |
| externalCustomerId | No | Your own reference ID for this customer | |
| registrationNumber | No | Business registration number | |
| accountPurposeOther | No | Explain purpose (required if accountPurpose is OTHER) | |
| legalAddressCountry | No | Legal address country code (for businesses) | |
| conductMoneyServices | No | Whether the company conducts money services | |
| registrationLocation | No | Registration location (e.g., state for USA) | |
| describeMoneyServices | No | Describe money services (required if conductMoneyServices is true) | |
| expectedAnnualRevenue | No | Estimated annual revenue in USD | |
| legalAddressPostalCode | No | Legal address postal code (for businesses) | |
| expectedMonthlyPayments | No | Expected monthly payments in USD | |
| sourceOfFundsDescription | No | Describe where your business funds come from | |
| describeComplianceControls | No | Description of compliance controls | |
| operateInProhibitedCountry | No | Does your business operate in any prohibited countries? | |
| doesYourBusinessEngageInHighRiskActivities | No | Does your business engage in high risk activities? |