Create individual customer
Create individual customers with optional KYC information
Unified Endpoint: This endpoint creates both individual and business customers. Use the type parameter to specify customer type (defaults to "individual").
Quick Example
Authorization
X-API-Key<token>Your Swipelux API key. Obtain this from the Swipelux Dashboard.
In: header
Request Body
application/jsonOptionaltypeunknownThe type of customer: individual (default) or business
"individual" | "business"firstNamestringThe first name of the customer
1Maximum length: 1024middleNamestringThe middle name of the customer
1Maximum length: 1024lastNamestringThe last name of the customer
1Maximum length: 1024legalNamestringThe legal name of the business (required when type is 'business')
1Maximum length: 1024websitestringThe website URL of the business (required when type is 'business')
1Maximum length: 2048emailstringThe primary email address of the customer
"email"phonestringThe primary phone number of the customer in E.164 format (e.g., +1234567890) - optional during creation
1Maximum length: 32metadataobjectThe provided metadata of the customer
birthDatestringThe date of birth of the customer in ISO 8601 format (YYYY-MM-DD)
"date"residentialAddressobjectThe residential address of the customer
identifyingInformationarray<object>An array of identifying information for the customer
shareTokenstringA SumSub share token for importing existing KYC verification data
1Response Body
The customer was created successfully
idRequiredstringA unique identifier for the customer
typeRequiredunknownThe type of customer: individual or business
"individual" | "business"firstNamestring | nullThe first name of the customer
middleNamestring | nullThe middle name of the customer
lastNamestring | nullThe last name of the customer
legalNamestring | nullThe legal name of the business (for business customers)
websitestring | nullThe website URL of the business (for business customers)
emailRequiredstringThe primary email address of the customer
"email"phoneRequiredstringThe primary phone number of the customer in E.164 format (e.g., +1234567890)
1Maximum length: 32birthDatestring | nullThe date of birth of the customer in ISO 8601 format (YYYY-MM-DD)
countrystring | nullThe country of the customer (ISO 3166-1 alpha-2 or alpha-3 code)
statusRequiredunknownThe KYC verification status of the customer
"not_started" | "incomplete" | "under_review" | "approved" | "rejected" | "pending_verification"metadataobject | nullThe provided metadata of the customer
walletAddressesarray<string>Array of customer wallet addresses (only present in legacy mode)
balanceRequirednumberThe total balance of the customer in USD
createdAtRequiredstringThe date and time the customer was created
updatedAtRequiredstringThe date and time the customer was last updated
Customer Types
type (optional)
Type: string
Values: "individual" (default) | "business"
Description: Specifies whether to create an individual or business customer.
"individual"(default): Creates a personal customer account withcus_prefix"business": Creates a business customer account withbiz_prefix
Example: Individual Customer (Default)
Request:
Response:
Example: Business Customer
Request:
Response:
Additional Parameters
shareToken (optional)
Type: string
Description: A SumSub share token that allows importing existing KYC verification data for seamless customer onboarding.
When you create a customer with a shareToken from SumSub, their KYC data will be automatically fetched and imported for onramp when creating transfers. This significantly improves the user experience by:
- Eliminating redundant verification: Customers don't need to re-verify their identity
- Faster onramp processing: KYC status is immediately available for transfer creation
- Higher conversion rates: Reduced friction leads to better completion rates
Example Request with ShareToken
Integration Notes
- Generate the
shareTokenfrom your SumSub integration before making the customer creation request - The shareToken must be valid and associated with completed KYC verification data
- Learn more about SumSub integration in our Advanced Features guide