Loading...
Integration guides

Onboarding

Sandbox onboarding flow testing guide

1. Fuzebox Configuration

Before interacting with the API, configure these components in Fuzebox:

  • API Access Credentials: Retrieve your Client ID, Client Secret, and Signature keys from the Customer tab.
  • Webhooks Notification URL: Set up your notifications webhook URL in the Accounts Configuration tab.

2. API authentication

Authenticate using the standard Volt OAuth endpoint to obtain an access token.

3. Testing onboarding flow and webhooks

A. Initiate onboarding process

  • Endpoint: Initiate onboarding using endpoint: onboarding/individual
  • Expected Outcome:
    • The full onboarding payload is retrievable via the Onboarding Details onboarding/individual/{onboardingEntityId}

B. Upload onboarding documents

  • Endpoint: Upload documents in loop using endpoint: onboarding/{onboardingEntityId}/documents
  • Expected Outcome:
    • Volt accepts Your documents

C. Trigger successful onboarding

  • Endpoint: Submit the onboarding process (once all required documents are uploaded) using endpoint: onboarding/{onboardingEntityId}/submit
  • Expected Outcome:
    • Volt accepts Your request
    • The full onboarding payload is retrievable via the Onboarding Details onboarding/individual/{onboardingEntityId}
    • Onboarding status changed to IN_REVIEW and APPROVED
    • A webhook notification is sent to your configured or overwritten URL.

D. Trigger onboarding with additional information required

  • Endpoint: Submit onboarding process (once all required documents are uploaded) using endpoint: onboarding/{onboardingEntityId}/submit
  • Requirement: Include the following testing header in your request:
  • Header: X-Volt-Testing-Scenario
  • Value: ONBOARDING_ADDITIONAL_INFO_REQUIRED
  • Expected Outcome:
    • Volt accepts Your request
    • The full onboarding payload is retrievable via the Onboarding Details onboarding/individual/{onboardingEntityId}
    • Onboarding status changed to ADDITIONAL_INFO_REQUIRED
    • A webhook notification is sent to your configured or overwritten URL.

E. Trigger rejected onboarding

  • Endpoint: Submit onboarding process using endpoint: onboarding/{onboardingEntityId}/submit
  • Requirement: Include the following testing header in your request:
  • Header: X-Volt-Testing-Scenario
  • Value: ONBOARDING_REJECTED
  • Expected Outcome:
    • The onboarding process is created and processed.
    • A webhook notification with type onboarding_rejected is sent to your configured URL.
    • The onboarding status is set to REJECTED.
    • No further actions (document upload or resubmission) are allowed.

F. Trigger expired onboarding

  • Endpoint: Submit onboarding process using endpoint: onboarding/{onboardingEntityId}/submit
  • Requirement: Include the following testing header in your request:
  • Header: X-Volt-Testing-Scenario
  • Value: ONBOARDING_EXPIRED
  • Expected Outcome:
    • The onboarding process is created but marked as expired.
    • A webhook notification with type onboarding_expired is sent to your configured URL.
    • The onboarding status is set to EXPIRED.
    • No further actions (document upload or resubmission) are allowed

G. Trigger successful Named Account order

  • Endpoint: Initiate a Named Account order using the standard Named Account ordering endpoint.
  • Expected Outcome:
    • A webhook notification with type named_account_order_completed is sent to your configured URL.
    • The Named Account order status is set to COMPLETED.
    • The Named Account details are available via the relevant retrieval endpoints.

H. Trigger failed Named Account order

  • Endpoint: Initiate a Named Account order using the standard Named Account ordering endpoint.
  • Requirement: Include the following testing header in your request:
  • Header: X-Volt-Testing-Scenario
  • Value: NAMED_ACCOUNT_ORDER_FAILED
  • Expected Outcome:
    • A webhook notification with type named_account_order_failed is sent to your configured URL.
    • The Named Account order status is set to FAILED.
    • No Named Account is created.

How is this guide?

Last updated on

On this page