Create Onboarding Grant

Create a one-time-use onboarding grant token for a customer and return a hosted onboarding URL.

This is Step 2 of the hosted onboarding integration. The returned onboarding_url should be used to redirect the end user's browser to the 1money-hosted KYB onboarding page.

How It Works

  1. Call this endpoint with a valid customer_id (from POST /v1/customers/hosted)
  2. Receive an onboarding_url containing the grant token
  3. Redirect the end user's browser to onboarding_url
  4. The grant token is exchanged for a secure session cookie (transparent to the user)
  5. The user lands on the hosted onboarding page and completes the KYB form

Grant Token Behavior

  • Single-use: Each grant token can only be exchanged once. After use, it cannot be reused.
  • Time-limited: Grant tokens expire after 30 minutes. If expired, create a new grant.
  • Re-creatable: You can create multiple grants for the same customer (e.g., for re-entry after session expiry or PENDING_RESPONSE status).
  • Session duration: After exchange, the browser session is valid for 24 hours.

Redirect URL

The optional redirect_url parameter specifies where the user is sent after completing or leaving the onboarding flow. It must be a valid URL and should be under your control. If not provided, users will be redirected to a default 1money page after onboarding.

When to Create a New Grant

ScenarioAction
First-time onboardingCreate grant, redirect user
User abandoned the formCreate new grant, redirect again (progress is preserved)
Grant token expiredCreate new grant
Status is PENDING_RESPONSECreate new grant to let user fix flagged items

Constraints

  • The customer_id must belong to a customer created via POST /v1/customers/hosted under your entity.
  • The customer's KYB status must allow editing (INIT, PENDING_RESPONSE, or REJECTED). Customers with APPROVED, PENDING_REVIEW, or UNDER_REVIEW status cannot start a new onboarding session.
Language
Credentials
Bearer
OneMoney-HMAC-SHA256
Response
Click Try It! to start a request and see the response here!