Skip to main content
This workflow creates the customer records used later by due diligence and reconciliation. The creation response gives you the identifiers you need, the current kyc_status, a verification_link, and any outstanding requirements.
  1. Call POST /onboarding to create the artist or label.
  2. Store customer_id, lumx_customer_id, and verification_link.
  3. Send the verification_link to the customer when user action is required.
  4. Poll GET /onboarding/{customer_id} until the KYC state reaches the status you need.
  5. If the verification flow needs to be restarted, call POST /onboarding/{customer_id}/resume-verification.
  6. For artist customers, register the payout PIX details with POST /onboarding/{customer_id}/create-bank-account.

​
What Each Endpoint Is For

  • POST /onboarding creates a customer and starts onboarding.
  • GET /onboarding/list returns the paginated customer list for the authenticated client.
  • GET /onboarding/{customer_id} returns the latest customer state.
  • POST /onboarding/{customer_id}/resume-verification refreshes or reuses the verification link for a non-terminal customer.
  • POST /onboarding/{customer_id}/create-bank-account registers or replaces the artist PIX bank account on the active public route.
  • DELETE /onboarding/{customer_id} removes the internal SVRN record when the customer should no longer exist.

​
Fields To Watch

  • kyc_status for the current review state
  • verification_link for the user-facing completion step
  • requirements for remaining actions or documents
  • bank_account_verification_status and bank_account_verification_level after PIX registration
POST /onboarding/{customer_id}/create-bank-account is for artist customers. Label customers are rejected on that route by the current implementation.