Skip to main content

Redirection API​

Application Layer API for Redirection

Header Parameters
    secretKey string required

    Secret key for authenticating the API request

Request Body required
    createdDate date-time required

    Date when the RM was created. Format to be used YYYY-MM-DD HH:MM:SS.ssssss

    email email required

    Possible values: <= 45 characters

    Users email address

    mobile string required

    Possible values: <= 15 characters

    Mobile number of the RM. Mandatory if the email is not provided.

    aadharNumber string

    Possible values: <= 12 characters

    Aadhaar number of the RM (Relationship Manager). Used for identity verification purposes if available. Optional field. Accepts a 12-digit numeric value

    address string

    Possible values: <= 100 characters

    Full residential or communication address of the RM. Can include flat number, street, locality, city, state, etc.Optional field. Used for contact and documentation purposes

    branchId string

    Possible values: <= 45 characters

    Unique identifier of the branch associated with the RM. If not provided, default to "BR001".Optional field but highly recommended for branch-wise reporting and analytics.

    dob date

    Date of birth of the RM. Format to be used YYYY-MM-DD

    gender string

    Possible values: [Male, Female, Other]

    Gender of the RM. Can be "Male", "Female", or "Other".Optional field, used for demographic insights.

    keyAccountManager string

    Possible values: <= 45 characters

    Unique ID of the Key Account Manager to whom the RM reports.Optional field. Used in assisted sales journeys and escalation mapping.

    married string

    Possible values: [Single, Married]

    Marital status of the RM. Optional field. Helps with customer profiling and communication tone customization.

    name string

    Possible values: <= 45 characters

    Full name of the RM. Used for login display, documentation, and official records.Optional field

    panNumber string

    Possible values: <= 11 characters

    PAN (Permanent Account Number) of the RM. Optional. Format must be 5 letters, 4 digits, and 1 letter (e.g., ABCDE1234F). Used for tax compliance and KYC.

    customerHashId string

    Possible values: <= 50 characters

    This is customer Identity or CRN number. In case of custom implementation, where customer selection was done before initiating Insurance journey and it is expected to prepopulate customer data.

    pospCode string

    Possible values: <= 45 characters

    POSP (Point of Sales Person) code assigned to the RM if applicable. Optional field for insurance sales compliance

    pospFlag string

    Indicates whether the RM is a certified POSP. Optional. Values like "Y" or "N" may be used.

    regionId string

    Possible values: <= 45 characters

    These are optional parameters and transactions need to be tagged with these parameters as per Distributor’s User profile. Example, user belonging to particular region.

    roleId string

    Possible values: <= 45 characters, [B2C, B2B, Admin, POS]

    • Customer – Applicable in case of DIY retail journey.
    • RM – Assisted Journey. In case of DIY, RM is expected to be SP, BQP, or PoSP certified.
    • Admin – A user having additional access (e.g., view of all cases, SP data management, etc.).
    • Agent – PoSP Agent.
    userId string

    Possible values: <= 45 characters

    User ID. RM code to be sent here

    userType string

    Possible values: <= 45 characters, [AC, CUC]

    These are optional parameters and transactions need to be tagged with these parameters as per Distributor’s User profile. Example, user belonging to particular region.

    lob string

    Possible values: <= 45 characters, [HEALTH, LIFE SAVE, LIFE TERM, MOTOR]

    This helps to identify which LoB application you want user to use. Eg Health, Life, Motor, etc

    homeUrl string

    Possible values: <= 200 characters

    Home URL

    logOutUrl string

    Possible values: <= 200 characters

    Log out URL

    startPage string

    Possible values: <= 200 characters

    Start page

    additionalSetup object

    This section will contain additional information regarding user and policy

    currency string

    Possible values: <= 5 characters, [AUD, NZD, USD, EUR, GBP, JPY, ZAR, CAD, CNY, ARS, BSD, BDT, BGN, BRL, CLP, KWD, COP, HRK, CZK, DKK, EGP, HKD, HUF, ISK, INR, IDR, ILS, KZT, KRW, CHF, MYR, MUR, MXN, NOK, PHP, PLN, QAR, RON, RUB, SAR, RSD, SGD, SEK, TWD, THB, TRY, UAH, VND, AED, MAD, PEN, UYU, OMR, BHD]

    Currency in which policy will be purchased

    userGeoLocation object

    Possible values: <= 100 characters

    Return a JSON object with latitude and longitude properties

    latitude string

    latitude

    longitude string

    longitude

    userCountry string

    Possible values: <= 5 characters, [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GO, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

    Country of the user

    userRegion string

    Possible values: <= 30 characters

    Region (State or Province) of the user

    userLanguage string

    Possible values: <= 20 characters

    Language set by user on the consumer app

    userIP string

    Possible values: <= 20 characters

    User IP address

    userAgent string

    Possible values: <= 50 characters

    User's browser details

Responses

Consumer Response

Schema
    reqId string required

    Unique request ID

    errors string[]

    List of error messages, if any

    data object
    status string

    Status of the transaction

    url string

    URL for accessing the processed resource

    transactionId string

    Unique transaction ID

Loading...