♧ WE WILL CALL YOU

Request a Callback

Tell us what you need help with, and our team will call you.

+91

Verify your mobile with a 6-digit OTP to submit your request.

Need help now? Send an enquiry through our contact form →

Onboarding User API

Let customers share the onboarding data they authorise.

Check what data is available, ask the customer to authorise access and retrieve only the details they permit. Request only what your application needs.

Need API access? Talk to our team.

Published API reference Authorised access Integration support

FROM REQUEST TO REVIEW

A clear path through the process.

  1. Check available data

    Submit the documented user identifier and your onboarding session reference.

  2. Complete customer consent

    Start the OAuth journey and let the customer authorise the permitted access.

  3. Retrieve and review details

    Exchange the returned code and request the consented data from your backend.

A CLOSER LOOK

What you can do with Onboarding User.

See how each feature works.

  1. Data-availability check

    Check the onboarding data scopes available for the supplied user identifier.

  2. Consent session

    Initiate the documented OAuth consent journey for the customer.

  3. Short-lived access token

    Exchange the completed consent flow's authorisation code for the user access token.

  4. Consented user details

    Use the token to retrieve the details the customer has authorised.

  5. Session references

    Keep the availability and consent steps associated with your own onboarding session reference.

FOR YOUR DEVELOPMENT TEAM

Take the next step with the right details.

See the documentation for request fields, responses and setup instructions.

  • Check the published inputs, response format and error handling.
  • Keep credentials on your server and collect only authorised data.
  • Confirm provider access and deployment requirements with BankU.

This is a consented data workflow, not automatic customer approval. Only collect, use and retain data needed for your disclosed and approved purpose.

BUILT AROUND YOUR WORK

Where Onboarding User fits.

Common uses for this API.

Customer applications

Bring permitted user details into an approved application process.

Form preparation

Use available, consented fields to help prepare an application for customer review.

Controlled data collection

Request data through a consent journey rather than collecting unrelated information.

GOOD QUESTIONS

Before you get started.

Common questions about Onboarding User.

Does the availability check return the full user profile?

No. It checks available scopes. Retrieving user details requires the completed consent journey and access token.

Is every onboarding field guaranteed to be available?

No. Available data and customer authorisation determine what the workflow can return.

Where should access tokens be handled?

Keep the token exchange and API credentials in your secure backend, following the published integration contract.