Skip to main content

Resolve a User [v2]‚Äč

This API helps you decide how you need to make a user login to access their personalised payment methods. The API decides whether you need to collect an otp or not. If no otp needs to be collected, the token for the user will be returned. If an otp needs to be collected then the token will be returned after submission of the otp with the /api/user/verify-otp

Request Body required
    mobile_number string required

    This is the mobile number of the user.

    country_code string nullable

    Default value: +91

    This is the country code as defined by the Internation Telecom Union

    user_agent string nullable

    The user_agent is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.

    ipAddress string nullable

    A unique numerical identifier for every device or network that connects to the internet. Typically assigned by an internet service provider (ISP), an IP address is an online device address used for communicating across the internet

    fingerPrint string required

    This is a unique device id generated by the client using a standard library such as fingerprint.js

    order_id string required

    This is unique order_id generated in the response of create-order

    device_verified string nullable

    This field isn't used

Responses

When the resolve user request is successful, the response will be as below


Schema
    success boolean required

    Possible values: [true]

    This key will always be true for a successful response

    next_step string required
    • This key explains the next API that can be called.
    • Where the next_step is payment_mode, the associated item array will contain the token that can be used in subsequent API calls
    • Where the next_step is verify_otp, the /api/user/verify-otp will need to be called to generate the user token

    otp_sent boolean required

    Possible values: [true]

    This field explains whether an otp needs to be collected or not. If otp_sent is true then an otp needs to be collected

    item object required

    This is the user information fetched from Nimbbl depending on the user details shared during the resolve user API call

    id integer required

    The unique internal id of the consumer

    email string nullable

    This is the email address of your consumer stored at Nimbbl

    first_name string nullable

    This is the first name of your consumer stored at Nimbbl

    last_name string nullable

    This is the last name of your consumer stored at Nimbbl

    country_code string required

    Default value: +91

    This is the country code as defined by the Internation Telecom Union

    mobile_number string required

    This is the mobile number of your consumer shared by you

    user_id string required

    This is the unique identifier for the consumer on Nimbbl

Loading...