Create an individual onboarding link using the API

Create a unique individual onboarding link for each user with the API.

Unique links using the API

• Unique onboarding links are single-use. If you get an HTTP 500 Internal Server Error when submitting the onboarding form, it's because an onboarding was already finalized using that link. You need to generate a new link.
• The true purpose of the state parameter is to prevent Cross-Site Request Forgery (CSRF) and related attacks. Consider using it to your advantage. It includes your user's onboarding ID by default, so you can save this onboarding ID when generating the link.

1. Call the createIndividualAccountHolderOnboarding mutation.
2. Enter information for all required API fields for the account country, as noted in country requirements for individual accounts.
3. Include optional fields as needed for your use case (such as accountInfo.name or oAuthRedirectParameters).
4. Add optional messages to the success payload, either for validation or in case of rejection.

Deprecated mutation

The previous onboardIndividualAccountHolder mutation is deprecated.

Creating onboardings with the deprecated mutations stops on 30 September 2026; the deprecated mutations and queries are removed on 31 December 2026.

Use createIndividualAccountHolderOnboarding for all new integrations.

Mutation

Open in API Explorer

mutation CreateIndividualOnboarding {
  createIndividualAccountHolderOnboarding(
    input: {
      accountInfo: {
        country: FRA
      }
      accountAdmin: {
        email: "malika.ngomao@mybrand.io"
        employmentStatus: Employee
        preferredLanguage: fr
        monthlyIncome: Between3000And4500
        address: {
          addressLine1: "123 avenue de Paris"
          city: "Paris"
          country: "FRA"
          postalCode: "75000"
        }
      }
    }
  ) {
    ... on CreateIndividualAccountHolderOnboardingSuccessPayload {
      __typename
      onboarding {
        id
        statusInfo {
          status
        }
      }
    }
  }
}

Payload

If you added validation or rejection messages, you'll see information such as the onboarding id as well as the current status Valid in the success payload.

{
  "data": {
    "createIndividualAccountHolderOnboarding": {
      "__typename": "CreateIndividualAccountHolderOnboardingSuccessPayload",
      "onboarding": {
        "id": "ae06faf6-13b2-4e9e-891b-e78ecd5ca0e4",
        "statusInfo": {
          "status": "Valid"
        }
      }
    }
  }
}