{icon &&

{color ?

}

{isInlineTag ?

{title} {tag && {tag}}

{title}

}

{children}

{tag && !isInlineTag &&

{tag}

} {linkText &&

{linkHref ? {linkText} : {linkText} }

}

; return href ? {card} : card; }; Customers must complete identity verification before processing conversions. The required information varies based on your platform's regulatory status. **Regulated platforms** have lighter KYC requirements since they handle compliance verification internally. The KYC/KYB flow allows you to onboard customers through direct API calls. Regulated financial institutions can: * **Direct API Onboarding**: Create customers directly via API calls with minimal verification * **Internal KYC/KYB**: Handle identity verification through your own compliance systems * **Reduced Documentation**: Only provide essential customer information required by your payment counterparty or service provider. * **Faster Onboarding**: Streamlined process for known, verified customers #### Creating Customers via Direct API For regulated platforms, you can create customers directly through the API without requiring external KYC verification: To register a new customer in the system, use the `POST /customers` endpoint: ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers" \ -H "Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "platformCustomerId": "customer_12345", "customerType": "INDIVIDUAL", "fullName": "Jane Doe", "birthDate": "1992-03-25", "nationality": "US", "address": { "line1": "123 Pine Street", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US" } }' ``` The examples below show a more comprehensive set of data. Not all fields are strictly required by the API for customer creation itself, but become necessary based on currency and UMA provider requirements if using UMA. ```json theme={null} { "platformCustomerId": "9f84e0c2a72c4fa", "customerType": "INDIVIDUAL", "fullName": "John Sender", "birthDate": "1985-06-15", "address": { "line1": "Paseo de la Reforma 222", "line2": "Piso 15", "city": "Ciudad de México", "state": "Ciudad de México", "postalCode": "06600", "country": "MX" } } ``` ```json theme={null} { "platformCustomerId": "b87d2e4a9c13f5b", "customerType": "BUSINESS", "businessInfo": { "legalName": "Acme Corporation", "registrationNumber": "789012345", "taxId": "123-45-6789", "incorporatedOn": "2018-03-14" }, "address": { "line1": "456 Oak Avenue", "line2": "Floor 12", "city": "New York", "state": "NY", "postalCode": "10001", "country": "US" } } ``` **Unregulated platforms** rely on Grid to run KYC for individuals and KYB for businesses. You can onboard customers either through the **hosted KYC/KYB link flow** below, or by **submitting customer data directly through the API**. Both paths produce the same `kycStatus` transitions and emit the same `CUSTOMER.KYC_APPROVED` / `CUSTOMER.KYC_REJECTED` / `CUSTOMER.KYC_PENDING` (and `CUSTOMER.KYB_*` equivalents) webhooks. Either path works for unregulated platforms: * **Hosted flow**: Redirect customers to a Grid-hosted link (or embed the provider SDK) for identity verification. Best when you want Grid to handle the entire collection UX. * **Direct API onboarding**: Collect customer information in your own UI and submit it via the API. For `INDIVIDUAL` customers (KYC), personal information goes through `POST /customers`. For `BUSINESS` customers (KYB), you also register beneficial owners via `POST /beneficial-owners`. Submit for review with `POST /verifications`. ### Hosted KYC Link Flow The hosted KYC flow provides a secure, hosted interface where customers can complete their identity verification and onboarding process. The flow is two steps: create the customer with the information you have, then generate a hosted KYC link for that customer. The customer's `kycStatus` stays `PENDING` until they complete the hosted flow. #### 1. Create the customer Create the customer with `POST /customers`, supplying at least `customerType` and any fields you already have. See [Configuring Customers](/payouts-and-b2b/onboarding/configuring-customers) for the full list of optional pre-fill fields. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "customerType": "INDIVIDUAL", "platformCustomerId": "9f84e0c2a72c4fa", "region": "US", "currencies": ["USD", "USDC"], "email": "jane.doe@example.com", "fullName": "Jane Doe" }' ``` Persist the returned `id` (the Grid customer ID) — you'll need it for the next step. #### 2. Generate a KYC link ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers/Customer:019542f5-b3e7-1d02-0000-000000000001/kyc-link" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -d '{ "redirectUri": "https://yourapp.com/onboarding-complete" }' ``` **Response:** ```json theme={null} { "kycUrl": "https://kyc.lightspark.com/onboard/abc123def456", "expiresAt": "2027-01-15T14:32:00Z", "provider": "SUMSUB", "token": "_act-sbx-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." } ``` The response always includes `kycUrl` for the hosted flow. For providers that support direct SDK integration (currently SUMSUB), a `token` is also returned — you can pass this to the provider's web SDK to embed verification in your own UI instead of redirecting. Both paths update the customer's `kycStatus` identically. #### Complete KYC Process Call `POST /customers` with `customerType` and any pre-fill fields you have. The returned `id` is the customer's Grid ID; their `kycStatus` is `PENDING` until verification completes. Call `POST /customers/{customerId}/kyc-link`. Each call returns a fresh single-use `kycUrl` and `expiresAt`; previously-issued links remain single-use but aren't invalidated. The `redirectUri` you pass is embedded in the generated `kycUrl` and is used to automatically return the customer to your application after they complete verification. Redirect the customer to `kycUrl`, or — if you want to embed the flow directly — initialize the provider's SDK with the returned `token`. The hosted URL is single-use and expires at `expiresAt`. If a customer needs to retry, call the endpoint again to generate a new link. Reaching your `redirectUri` only means the customer **finished the hosted flow** — not that they were approved. Wait for the final decision in one of two ways: * **Webhook (recommended):** Subscribe to `CUSTOMER.KYC_APPROVED` / `CUSTOMER.KYC_REJECTED` (and `CUSTOMER.KYB_APPROVED` / `CUSTOMER.KYB_REJECTED` for business customers) to be notified when the customer reaches a terminal status. `CUSTOMER.KYC_PENDING` (and the `KYB_PENDING` sibling) also fires when the customer is submitted for review — subscribe to it as well if you want to surface an "under review" state to the customer. * **Polling:** Call `GET /customers/{customerId}` and inspect `kycStatus`. On `APPROVED`, the customer is ready to transact — proceed with account setup and unlock funding. On `REJECTED`, surface the appropriate next step (for example, regenerate the link or request manual review). ### Direct API Onboarding Prefer to collect identity information in your own UI and submit it to Grid yourself? Use the API directly instead of redirecting to a hosted link. The customer's `kycStatus` transitions the same way and you receive the same `CUSTOMER.KYC_APPROVED` / `CUSTOMER.KYC_REJECTED` / `CUSTOMER.KYC_PENDING` (and `CUSTOMER.KYB_*` equivalents) webhooks. The shape of the flow depends on the customer type: * **KYC (`INDIVIDUAL` customers)** — supply the customer's personal information through the customer endpoint. No beneficial owners are involved. * **KYB (`BUSINESS` customers)** — create the business customer, then register its beneficial owners, directors, and officers individually. Call `POST /customers` with `customerType: INDIVIDUAL` and the personal information collected from the customer (legal name, date of birth, address, nationality, etc.). The returned `id` is the customer's Grid ID; `kycStatus` starts at `PENDING`. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "customerType": "INDIVIDUAL", "platformCustomerId": "9f84e0c2a72c4fa", "fullName": "Jane Doe", "birthDate": "1985-06-15", "nationality": "US", "email": "jane.doe@example.com", "address": { "line1": "123 Pine Street", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US" } }' ``` Some jurisdictions or currencies require an ID document or proof of address. Upload them with `POST /documents` using `multipart/form-data`, referencing the customer by `customerId`. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/documents" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -F "documentHolder=Customer:019542f5-b3e7-1d02-0000-000000000001" \ -F "documentType=PASSPORT" \ -F "documentNumber=A12345678" \ -F "issuingAuthority=U.S. Department of State" \ -F "country=US" \ -F "file=@./passport.jpg" ``` Call `POST /verifications` to submit the customer for review. The response includes a `verificationStatus`. If anything is missing, `verificationStatus` is `RESOLVE_ERRORS` and the `errors` array describes exactly what to collect before retrying. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/verifications" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001" }' ``` **Submitted successfully:** ```json theme={null} { "id": "Verification:019542f5-b3e7-1d02-0000-000000000002", "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "verificationStatus": "IN_PROGRESS", "errors": [], "createdAt": "2025-10-03T12:00:00Z" } ``` **Blocked by missing data:** ```json theme={null} { "id": "Verification:019542f5-b3e7-1d02-0000-000000000001", "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "verificationStatus": "RESOLVE_ERRORS", "errors": [ { "resourceId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "type": "MISSING_PROOF_OF_ADDRESS_DOCUMENT", "acceptedDocumentTypes": ["PROOF_OF_ADDRESS"], "reason": "Proof of address document is required" } ], "createdAt": "2025-10-03T12:00:00Z" } ``` Track terminal `kycStatus` transitions via the `CUSTOMER.KYC_APPROVED` / `CUSTOMER.KYC_REJECTED` webhook (recommended) or by polling `GET /customers/{customerId}`. `CUSTOMER.KYC_PENDING` also fires when the customer is submitted for review — subscribe to it if you want to surface an "under review" state. On `APPROVED`, unlock funding and money movement. When Grid runs KYB for a business customer, the following information and documents are collected before onboarding completes. Use this list to plan what to gather from the business — provide it via `POST /customers`, `POST /beneficial-owners`, and `POST /documents` (or through the hosted flow). #### Business identifying information * Entity full legal name * Doing Business As (DBA) name, if applicable * Physical address — the principal place of business, local office, or other physical location of the entity opening the account * Countries of operation * Identification number — U.S. taxpayer identification number, or, for a foreign business without one, alternative government-issued documentation certifying the existence of the business #### Ownership and control structure Collected for: * **One control person** — a single individual with significant responsibility to control, manage, or direct the legal entity, **and** * **All beneficial owners** — every individual who owns 25% or more of the legal entity, directly or indirectly. For every such individual, provide: * Full name * Date of birth * Address * Identification number, by residency: * **U.S. persons** — Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) * **Non-U.S. persons** — one or more of: ITIN, passport number with country of issuance, alien identification card number, or another government-issued document evidencing nationality or residence and bearing a photograph or similar safeguard #### Required documents * Company formation and existence documents. For example: * Certificate of incorporation * Articles of association * Proof of ownership and control structure. For example: * Corporate organization and ownership chart * Shareholder agreements * Operating agreements * Register of members * Certification of controlling person and beneficial owners * Proof of address, dated within the last 3 months. For example: * Utility bill * Bank statement * Lease agreement * Official correspondence * Tax ID or equivalent identifying-number documents * For non-U.S. beneficial owners — passport plus one additional government-issued ID. For example: * National ID Call `POST /customers` with `customerType: BUSINESS` and the business information (legal name, registration number, tax ID, registered address). ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "customerType": "BUSINESS", "platformCustomerId": "b87d2e4a9c13f5b", "businessInfo": { "legalName": "Acme Corporation", "registrationNumber": "789012345", "taxId": "123-45-6789", "incorporatedOn": "2018-03-14" }, "address": { "line1": "456 Oak Avenue", "city": "New York", "state": "NY", "postalCode": "10001", "country": "US" } }' ``` Register each beneficial owner, director, or officer with `POST /beneficial-owners`. Each one is verified individually with their own personal information. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/beneficial-owners" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "roles": ["DIRECTOR"], "ownershipPercentage": 40, "personalInfo": { "firstName": "Jane", "lastName": "Doe", "birthDate": "1985-06-15", "nationality": "US", "address": { "line1": "123 Pine Street", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US" }, "idType": "SSN", "identifier": "123-45-6789" } }' ``` Upload business documents (registration, articles of incorporation) and any documents required for individual beneficial owners with `POST /documents`. Reference the company by `customerId` and each owner by `beneficialOwnerId`. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/documents" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -F "documentHolder=BeneficialOwner:019542f5-b3e7-1d02-0000-00000000abcd" \ -F "documentType=PASSPORT" \ -F "documentNumber=B98765432" \ -F "issuingAuthority=U.S. Department of State" \ -F "country=US" \ -F "file=@./owner-passport.jpg" ``` Call `POST /verifications` to submit the business for review. The response includes a `verificationStatus`. If beneficial owners, fields, or documents are missing, `verificationStatus` is `RESOLVE_ERRORS` and the `errors` array tells you exactly what to collect — note that `resourceId` may point at either the customer or a specific beneficial owner. ```bash theme={null} curl -X POST "https://api.lightspark.com/grid/2025-10-13/verifications" \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001" }' ``` **Blocked by missing data:** ```json theme={null} { "id": "Verification:019542f5-b3e7-1d02-0000-000000000001", "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "verificationStatus": "RESOLVE_ERRORS", "errors": [ { "resourceId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "type": "MISSING_FIELD", "field": "customer.address.line1", "reason": "Business address line 1 is required" }, { "resourceId": "BeneficialOwner:019542f5-b3e7-1d02-0000-000000000002", "type": "MISSING_FIELD", "field": "personalInfo.birthDate", "reason": "Date of birth is required for beneficial owners" } ], "createdAt": "2025-10-03T12:00:00Z" } ``` **Submitted successfully:** ```json theme={null} { "id": "Verification:019542f5-b3e7-1d02-0000-000000000002", "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001", "verificationStatus": "IN_PROGRESS", "errors": [], "createdAt": "2025-10-03T12:00:00Z" } ``` Track terminal `kycStatus` transitions via the `CUSTOMER.KYB_APPROVED` / `CUSTOMER.KYB_REJECTED` webhook (recommended) or by polling `GET /customers/{customerId}`. `CUSTOMER.KYB_PENDING` also fires when the business is submitted for review — subscribe to it if you want to surface an "under review" state. On `APPROVED`, unlock funding and money movement. ## Monitor verification status After a customer completes the KYC/KYB verification process, you'll receive webhook notifications about their KYC status. These notifications are sent to your configured webhook endpoint. For regulated platforms, customers are created with `APPROVED` KYC status by default. **Webhook Payload (sent to your endpoint):** ```json theme={null} { "id": "Webhook:019542f5-b3e7-1d02-0000-000000000020", "type": "CUSTOMER.KYC_APPROVED", "timestamp": "2025-07-21T17:32:28Z", "data": { "id": "Customer:019542f5-b3e7-1d02-0000-000000000001", "platformCustomerId": "9f84e0c2a72c4fa", "customerType": "INDIVIDUAL", "umaAddress": "$john.doe@uma.domain.com", "kycStatus": "APPROVED", "fullName": "John Michael Doe", "birthDate": "1990-01-15", "nationality": "US", "address": { "line1": "123 Main Street", "line2": "Apt 4B", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "US" }, "createdAt": "2025-07-21T17:32:28Z", "updatedAt": "2025-07-21T17:32:28Z", "isDeleted": false } } ``` **Webhook Headers:** * `Content-Type: application/json` * `X-Grid-Signature: {"v": "1", "s": "base64_signature..."}` Unique identifier for this webhook delivery. Use this for idempotency to prevent processing duplicate webhooks. Status-specific event type. KYC/KYB webhooks use `CUSTOMER.*` types: * `CUSTOMER.KYC_APPROVED`: Individual customer verification completed successfully * `CUSTOMER.KYC_REJECTED`: Individual customer verification was rejected * `CUSTOMER.KYC_PENDING`: Individual customer is awaiting review * `CUSTOMER.KYB_APPROVED` / `CUSTOMER.KYB_REJECTED` / `CUSTOMER.KYB_PENDING`: business equivalents (only fires for `customerType: BUSINESS`) The full customer resource object, same as the corresponding `GET /customers/{id}` endpoint would return. Includes all customer fields such as `id`, `kycStatus`, `fullName`, `birthDate`, `nationality`, `address`, etc. `CUSTOMER.KYC_PENDING` (or `CUSTOMER.KYB_PENDING`) fires when a customer enters `kycStatus: PENDING` (for example, after they are submitted for review). Final outcomes use `CUSTOMER.KYC_APPROVED` / `CUSTOMER.KYC_REJECTED` (and the `CUSTOMER.KYB_*` siblings for business customers). ```javascript theme={null} // Example webhook handler for KYC status updates. // CUSTOMER.KYC_APPROVED and CUSTOMER.KYC_REJECTED are terminal decisions; // CUSTOMER.KYC_PENDING is an intermediate signal that the customer has been // submitted for review (useful for surfacing "we're still reviewing" UI). app.post('/webhooks/kyc-status', async (req, res) => { const { type, data } = req.body; switch (type) { case 'CUSTOMER.KYC_APPROVED': // Activate customer account await activateCustomer(data.id); await sendWelcomeEmail(data.id); break; case 'CUSTOMER.KYC_REJECTED': // Notify support and customer await notifySupport(data.id, 'KYC_REJECTED'); await sendRejectionEmail(data.id); break; case 'CUSTOMER.KYC_PENDING': // Intermediate: customer submitted for review, no decision yet await markCustomerUnderReview(data.id); break; case 'CUSTOMER.KYB_APPROVED': // Business customer decision: activate await activateCustomer(data.id); await sendWelcomeEmail(data.id); break; case 'CUSTOMER.KYB_REJECTED': // Business customer decision: notify await notifySupport(data.id, 'KYB_REJECTED'); await sendRejectionEmail(data.id); break; case 'CUSTOMER.KYB_PENDING': // Intermediate: business customer submitted for review await markCustomerUnderReview(data.id); break; default: // Log unexpected types console.log(`Unexpected webhook type ${type} for customer ${data.id}`); } res.status(200).send('OK'); }); ``` Only customers with `APPROVED` status can create quotes and process conversions. *** ## Customer types For personal conversions and consumer wallets. **Required fields:** `fullName`, `email`, `birthDate`, `address` ```bash theme={null} curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers' \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H 'Content-Type: application/json' \ -d '{ "platformCustomerId": "user_12345", "customerType": "INDIVIDUAL", "fullName": "Alice Johnson", "email": "alice@example.com", "birthDate": "1990-01-15", "address": {...} }' ``` For corporate conversions and business accounts. **Required fields:** `customerType`, plus `businessInfo.legalName`, `businessInfo.taxId`, and `businessInfo.incorporatedOn`. Most providers also require `address` for KYB. ```bash theme={null} curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers' \ -u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \ -H 'Content-Type: application/json' \ -d '{ "platformCustomerId": "biz_67890", "customerType": "BUSINESS", "email": "finance@acme.com", "businessInfo": { "legalName": "Acme Corporation", "taxId": "12-3456789", "incorporatedOn": "2018-03-14" }, "address": {...} }' ``` *** ## Next steps Fund crypto for off-ramp conversions Set up wallet destinations Build conversion flows Complete customer API docs