CHECK_USER

The sequence of actions for any FD-related flow begins with the CHECK_USER action. This action returns the user's ID for an existing user. For a new user, the user's ID is created with this action code.

The response contains state field which denotes whether the provided user exists in the system or is a new user. For a new user (denoted by NEW), the response also contains the kycUrl. To proceed with the user's min-kyc, please open this URL inside a webview.

Once the user completes min-kyc the statechanges to EKYC.

CHECK_USER needs the user's PAN and mobileNumber for de-dup check. This action returns the userID which will be user in subsequent requests.

Request

    payload: {
      pan: 'AXPPA7777A',
      email: '[email protected]',
      phone: '8888899999',
      isEmailVerified: 'YES',
      isPhoneVerified: 'YES',
      phoneVerificationDate: '2023-09-15 10:10:10',
      emailVerificationDate: '2023-09-15 10:10:10',
      dateOfBirth: '1997-12-14',
      nameAsPerPan: 'vivek singh',
      callbackUrl: 'https://www.google.com',
    },

Response

{
        "userId": "095b6e91-5035-4bc4-8f90-b3620c77e2d3",
        "kycUrl": "https://eohs-uat.shivalikbank.com/Aadhaar?callbackUrl=https://www.google.com/&applicationId=UPS01_PUPS01/AGUPS01/2454/040124121800_2&clientId=UPS01&mobileNumber=8219092454&accessToken=eyJ4NXQjUzI1NiI6ImRwZEdBYlVhUUFrNWFLNUV0LWFGUC1MZU51ci0yS0x0V0VRVDluOFdRSmMiLCJ4NXQiOiJiWmtyTEpERURlOVJaU1I2bkFwQlc1RVdSWUkiLCJraWQiOiJTSUdOSU5HX0tFWSIsImFsZyI6IlJTMjU2In0.eyJjbGllbnRfb2NpZCI6Im9jaWQxLmRvbWFpbmFwcC5vYzEuYXAtbXVtYmFpLTEuYW1hYWFhYWE2emJ1N2J5YTRyb2kyNjI2dWYyc2xpdmg0a2RzdzZqcjQ0Y3NrYnF1bmZlMjRhaDVjN3JxIiwidXNlcl90eiI6IkFzaWFcL0tvbGthdGEiLCJzdWIiOiJzbWJUZXN0VXNlciIsInVzZXJfbG9jYWxlIjoiZW4iLCJzaWRsZSI6NDgwLCJ1c2VyLnRlbmFudC5uYW1lIjoiaWRjcy02M2M0MDVmMTUzMjU0ZDU5YTZlMDM0NTIwNDRjN2ZiZCIsImlzcyI6Imh0dHBzOlwvXC9pZGVudGl0eS5vcmFjbGVjbG91ZC5jb21cLyIsInVzZXJfdGVuYW50bmFtZSI6ImlkY3MtNjNjNDA1ZjE1MzI1NGQ1OWE2ZTAzNDUyMDQ0YzdmYmQiLCJjbGllbnRfaWQiOiIyMzIzRUJFNUQ2Rjc0QkQzQUVGRjUzNUE2RjJCMjRCQl9BUFBJRCIsInN1Yl90eXBlIjoidXNlciIsInNjb3BlIjoidXJuOm9wYzpyZXNvdXJjZTpjb25zdW1lcjo6YWxsIiwidXNlcl9vY2lkIjoib2NpZDEudXNlci5vYzEuLmFhYWFhYWFhbTVrb3ZzYmdpb2YybWpobHFoZnBvYWlxMnBpZXVsaHVpNGpqMzVxYXB2bHJ1YjZubDZ6YSIsImNsaWVudF90ZW5hbnRuYW1lIjoiaWRjcy02M2M0MDVmMTUzMjU0ZDU5YTZlMDM0NTIwNDRjN2ZiZCIsInJlZ2lvbl9uYW1lIjoiYXAtbXVtYmFpLWlkY3MtMSIsInVzZXJfbGFuZyI6ImVuIiwiZXhwIjoxNzA0MzU0NDc5LCJpYXQiOjE3MDQzNTA4NzksImNsaWVudF9ndWlkIjoiZjc3NWZjYmRkNWY2NDU4OGFkZWQ0ODkwZDNjMmVlMTYiLCJjbGllbnRfbmFtZSI6InNtYm5vbnByb2RvaWNwbGF0Zm9ybS1ibW9zMXJmbHl4bzctYm8iLCJ0ZW5hbnQiOiJpZGNzLTYzYzQwNWYxNTMyNTRkNTlhNmUwMzQ1MjA0NGM3ZmJkIiwianRpIjoiNzk4NDAyMmRiN2EzNDZiNmI0NjIyZThlNTk4NWY2YmUiLCJndHAiOiJybyIsInVzZXJfZGlzcGxheW5hbWUiOiJTTUIgUmVhZCBPbmx5IFRlc3QiLCJvcGMiOnRydWUsInN1Yl9tYXBwaW5nYXR0ciI6InVzZXJOYW1lIiwicHJpbVRlbmFudCI6dHJ1ZSwidG9rX3R5cGUiOiJBVCIsImNhX2d1aWQiOiJjYWNjdC1lNzdlZTU4M2JkYWQ0NWUzYjAzM2U5ZDc0MDI3ZmUyMiIsImF1ZCI6WyJodHRwczpcL1wvc21iZGV2b2ljcGxhdGZvcm0tYm1vczFyZmx5eG83LWJvLmludGVncmF0aW9uLmFwLW11bWJhaS0xLm9jcC5vcmFjbGVjbG91ZC5jb206NDQzIiwiaHR0cHM6XC9cL2Rlc2lnbi5pbnRlZ3JhdGlvbi5hcC1tdW1iYWktMS5vY3Aub3JhY2xlY2xvdWQuY29tP2ludGVncmF0aW9uSW5zdGFuY2U9c21iZGV2b2ljcGxhdGZvcm0tYm1vczFyZmx5eG83LWJvIiwiaHR0cHM6XC9cL3NtYmRldm9pY3BsYXRmb3JtLWJtb3MxcmZseXhvNy1iby5pbnRlZ3JhdGlvbi5vY3Aub3JhY2xlY2xvdWQuY29tOjQ0MyIsInVybjpvcGM6bGJhYXM6bG9naWNhbGd1aWQ9OUU2QjBGQTY4RDIzNDIxOUIzMjJCMkJFMEI3QzdFMTkiLCJodHRwczpcL1wvMjMyM0VCRTVENkY3NEJEM0FFRkY1MzVBNkYyQjI0QkIuaW50ZWdyYXRpb24ub2NwLm9yYWNsZWNsb3VkLmNvbTo0NDMiLCJodHRwczpcL1wvc21ibm9ucHJvZG9pY3BsYXRmb3JtLWJtb3MxcmZseXhvNy1iby5pbnRlZ3JhdGlvbi5vY3Aub3JhY2xlY2xvdWQuY29tOjQ0MyIsInVybjpvcGM6bGJhYXM6bG9naWNhbGd1aWQ9MjMyM0VCRTVENkY3NEJEM0FFRkY1MzVBNkYyQjI0QkIiLCJodHRwczpcL1wvOUU2QjBGQTY4RDIzNDIxOUIzMjJCMkJFMEI3QzdFMTkuaW50ZWdyYXRpb24ub2NwLm9yYWNsZWNsb3VkLmNvbTo0NDMiXSwic3R1IjoiSU5URUdSQVRJT05DQVVUTyIsInVzZXJfaWQiOiI2MTFmZWY1NzcyZGQ0MTExYjQwNDQ0NDgwNTk4NDhhMSIsImRvbWFpbiI6ImlkZW50aXR5IiwidGVuYW50X2lzcyI6Imh0dHBzOlwvXC9pZGNzLTYzYzQwNWYxNTMyNTRkNTlhNmUwMzQ1MjA0NGM3ZmJkLmlkZW50aXR5Lm9yYWNsZWNsb3VkLmNvbTo0NDMiLCJyZXNvdXJjZV9hcHBfaWQiOiJmNzc1ZmNiZGQ1ZjY0NTg4YWRlZDQ4OTBkM2MyZWUxNiJ9.AsN2TaT7SyQWJ6FttdGvzCqxDHsX9bCDcfrt6f7dLnPpiYQ-kldnGVgvTGrSuiGNGC1TtEr3zzFK_JWIIr8dZ1jJ_jHnN9eyV6swoxyrSClPK2eVxr0bxyDo_8SDD1VtkzyO4tJWvyY6nqVE2yOlPxGD_oawNGzB4TJg-WYj46OzOxiqizSsoY0rRHHqvc4zUtbmZi45aY0cB0XMDrPkaWzsy8VqZedouBzZgxr3th9qXIJSRY4FXUhJ5ioUhicMB-MjFGVuNWjS-vdvaVGKPdAY6aTc48Tv1jAQ1Dm_sCdn2yMPIUVu_PpBKGgFOGl_9ltEklt1HNe0bYZVgJiZwA",
        "state": "NEW",
        "kycUrlExpiry": "2024-01-04T07:45:00.086+00:00"
}