Third Party
Name | Description | Introduced In |
---|---|---|
validateDocument | This API retrieves the details of the scanned document. The supported documents are Passport and Driving Licence. | 2021.01 |
verifyLiveliness | This API verifies the liveliness selfie (Far selfie) with the photo of the client in the document. | 2021.01 |
updateSelfieScoreAndResult | This API updates the selfie score and result fetched from the Authentic ID to the Origination Data Microservice (ODMS). | 2021.01 |
executeIDV | This API executes the Identity verification module of an applicant by leveraging a third-party service called IDology. | 2021.01 |
verifyResponse | This API verifies the response or answers that are provided by the user to the identity verification questions by leveraging the IDology service. | 2021.01 |
getToken | This API allows to get the Token. | 2022.10 |
initiateDoc | This API allows to initiate the document. | 2022.10 |
getDocumentStatus | This API allows to get the document status. | 2022.10 |
getDocumentDetails | This API allows to get the document details. | 2022.10 |

Description: | Retrieves the address suggestions based on the address that is being typed by the user and the user's current location by using Google APIs. For example, when a user is typing an address, this API creates a circle with the location of the user as the center of the circle. The API then provides address suggestions from locations within the circle that match the address that is being typed by the user. If there are no suggestions that can be provided within the circle, then the API fetches the locations from outside the circle and suggests the addresses to the user. The maximum number of address suggestions that the API can fetch is 5. The API response contains a parameter called Place_ID, which is used by the getFormattedAddress API to fetch additional address details. | |||||
Method: | POST | |||||
URL: | {{baseUrl}}/services/data/v1/PartyDetailsThirdparty/operations/Locations/getAddressSuggestions | |||||
Security Level: | Authorized App User | |||||
Header Request: |
|
|||||
Body Request: |
Parameters currLatitude Specifies the current latitude. currLatitude Specifies the current latitude. query { "currLatitude": "11.127122499999999", "currLongitude": "78.6568942", "query": "tem" } |
|||||
Response: |
Locations [] Specifies the Address with the place ID. Parameters Locations/formattedAddress Specifies the formatted address (The suggested address). Locations/place_id Specifies the place id. { "Locations": [{ "formattedAddress": "Brihadeeswara Temple, Membalam Road, Balaganapathy Nagar, Thanjavur, Tamil Nadu, India", "place_id": "ChIJIRL-SJ-4qjsR1oRd5UDLIx0" }, { "formattedAddress": "Tembhurni, Maharashtra, India", "place_id": "ChIJB1O0UpBvxDsRlAFi4Or4AYE" }, { "formattedAddress": "Temptation, Round Road, Elil Nagar, Dindigul, Tamil Nadu, India", "place_id": "ChIJa4oXYUSqADsR3AZM89Iz-Cw" }, { "formattedAddress": "Temple, Thanjavur, Tamil Nadu, India", "place_id": "ChIJZ_BoCNq6qjsRnDrpNB7MbEE" }, { "formattedAddress": "Temanggung, Temanggung Regency, Central Java, Indonesia", "place_id": "ChIJf2Zev5yCei4RcD1T2zYAtUE" }], "opstatus": 0, "httpStatusCode": 200 } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | Retrieves the additional address details based on the address suggestion that is selected by the applicant. Every address suggestion is associated with a specific place_ID and by using this unique ID, the API fetches the additional details. The address details include information on the street, city, country, and zip code. | |||||
Method: | POST | |||||
URL: | {{baseUrl}}/services/data/v1/PartyDetailsThirdparty/operations/Locations/getFormattedAddress | |||||
Security Level: | Anonymous App User | |||||
Header Request: |
|
|||||
Body Request: |
Parameters place_id Specifies the id of a particular place. { "place_id": "ChIJAXznRt41W4YRP1Dhw1NrYo0" } |
|||||
Response: |
Locations [] Specifies the Address with the place ID. Parameters Locations/formattedAddress Specifies the formatted address (The suggested address). Locations/address_components Specifies the various components of an address. Locations/types Specifies the formatted address type. Locations/short_name Specifies the truncated address. Locations/long_name Specifies the complete address. { "Locations": [{ "formattedAddress": "KG360, IT Business Park, Second Floor, Plot No. 232/1 Veeranam Street, OMR Bypass Road, MGR Salai, Thiruvengadam Nagar, Perungudi, Chennai, Tamil Nadu 600096, India", "address_components": "[{" types ":[" route "]," short_name ":" MGR Salai "," long_name ":" MGR Salai "},{" types ":[" sublocality_level_2 "," sublocality "," political "]," short_name ":" Thiruvengadam Nagar "," long_name ":" Thiruvengadam Nagar "},{" types ":[" sublocality_level_1 "," sublocality "," political "]," short_name ":" Perungudi "," long_name ":" Perungudi "},{" types ":[" locality "," political "]," short_name ":" Chennai "," long_name ":" Chennai "},{" types ":[" administrative_area_level_2 "," political "]," short_name ":" Chennai "," long_name ":" Chennai "},{" types ":[" administrative_area_level_1 "," political "]," short_name ":" TN "," long_name ":" Tamil Nadu "},{" types ":[" country "," political "]," short_name ":" IN "," long_name ":" India "},{" types ":[" postal_code "]," short_name ":" 600096 "," long_name ":" 600096 "}]" }], "opstatus": 0, "httpStatusCode": 200 } |
|||||
Error Code(s): |
None |
|||||
Service Flow: |
|

Description: | Retrieves the details of the scanned document. The supported documents are Passport and Driving Licence. This API leverages a third-party vendor called AuthenticID. | ||||
Method: | POST | ||||
URL: | {base_url}/services/data/v1/Thirdparty/operations/DocumentValidation/validateDocument | ||||
Security Level: | Anonymous App User | ||||
Header Request: |
|
||||
Body Request: |
Parameters accountCode (Mandatory) Specifies the unique code associated with the account. documentType (Mandatory) Specifies the type of document (Passport/ License). frontImage64 (Mandatory) Specifies the front image of the document. The image must be recorded in Base 64 format. backImage64 (Mandatory) Specifies the back image of the document. The image must be recorded in Base 64 format. { "accountCode":"9999", "documentType":"License/Passport", "frontImage64":"xxxx", "backImage64":"xxxx" } The parameters change based on the type of document. If the document type is Passport, then the documentType and frontImage64 parameter are required. If the mandatory parameter is License, then all the three parameters are mandatory. |
||||
Response: |
![]() /verifyStatus Specifies the status of the verification process. /prefillData Specifies the pre-filled data generated based on the document submitted. /executionStatus Specifies the status of the execution process. /LocationCode Specifies the unique location code. /ActionCode Specifies the unique action code for the verification. /ActionMessage Specifies the message associated with the action. /transactionId Specifies the unique ID of the transaction. ![]() { "verifyStatus":"WAITING_SELFIE", "prefillData":{ "DQL_Final_IssuerCode_Result":"IND", "DQL_Final_AddressLine1_Result":"", "DQL_Final_IssuerCountryCode2Digit_Result":"IN", "DQL_Final_IssuerCountryCode_Result":"IND", "DQL_Final_ClassName_Result":"Passport", "DQL_Final_BirthDate_Result":"12/Apr/1995", "DQL_Final_AddressPostalCode_Result":"", "DQL_Final_IssueDate_Result":"", "DQL_Final_FirstName_Result":"SHUBHAM", "DQL_Final_AddressState_Result":"", "DQL_Final_DocumentNumber_Result":"", "DQL_Final_Surname_Result":"AHUJA", "DQL_Final_ExpirationDate_Result":"", "DQL_Final_AddressCity_Result":"" }, "executionStatus":"SUCCESS", "LocationCode":"9999", "ActionCode":"99", "ActionMessage":"Please click to Continue.", "opstatus":0, "transactionId":"HDABsmeHAGFUQuFN", "httpStatusCode":0 } |
||||
Error Code(s): |
|
||||
Service Flow: |
|

Description: | Verifies the liveliness selfie (Far selfie) with the photo of the client in the document. This API leverages a third party vendor called AuthenticID. | |||||
Method: | POST | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/LivelinessVerification/verifyLiveliness | |||||
Security Level: | Authenticated App User | |||||
Header Request: |
|
|||||
Body Request: |
Parameters /accountCode (Mandatory) Specifies the unique code associated with the account. /farSelfieImage64 (Mandatory) Specifies the base 64 image code of the static selfie. /transactionId (Mandatory) Specifies the unique ID of the transaction. { "accountCode":"9999", "farSelfieImage64":"xxxx", "transactionId":"xxxx" } |
|||||
Response: |
Parameters /verifyStatus Specifies the status of the verification process. /executionStatus Specifies the status of the execution process. /ActionCode Specifies the unique action code for the verification. /ActionMessage Specifies the message associated with the action. /transactionId Specifies the unique ID of the transaction. /livelinessSelfieData Specifies the data associated with the static selfie. /livelinessSelfieData/VerificationScore Specifies the verification score for the static selfie. /livelinessSelfieData/DQL_Selfie1Liveness_Result Specifies the selfie liveliness result. /livelinessSelfieData/DQL_FarSelfie_Liveness_Result Specifies the far selfie liveliness result. { "verifyStatus":"Verified", "executionStatus":"xxxx", "ActionCode":"99", "ActionMessage":"Success", "transactionId":"xxxx", "livelinessSelfieData":{ "VerificationScore":"xxxx", "DQL_Selfie1Liveness_Result":"Passed", "DQL_FarSelfie_Liveness_Result":"Passed" }, "errorCode":"", "errorMessage":"" } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | Updates the selfie score and result fetched from the Authentic ID to the Origination Data Microservice (ODMS). | |||||
Method: | POST | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/Selfie/updateSelfieScoreAndResult | |||||
Security Level: | Authenticated App User | |||||
Header Request: |
|
|||||
Body Request: |
Parameters /SelfieScore Specifies the score of the selfie. /SelfieResult Specifies the result of the selfie (passed/failed) /LivenessSelfieScore Specifies the liveliness score of the selfie. /LivenessSelfieResult Specifies the result of the liveliness selfie. /FarSelfieResult Specifies the result of the far selfie. /SectionProgress Specifies the progress of the process. /ApplicantType Specifies the type of applicant (Applicant/Co-Applicant) { "SelfieScore": "70", "SelfieResult": "Passed", "LivenessSelfieScore": "70", "LivenessSelfieResult": "Passed", "FarSelfieResult": "Passed", "SectionProgress": "Done", "ApplicantType": "Applicant", "ConsentIdentifier": "Create_IDScan_Consent", "AcceptanceStatus": "Yes" } |
|||||
Response: | { "opStatus":0, "httpStatusCode":200 } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | Executes the Identity verification module of an applicant by leveraging a third-party service called IDology. Based on the execution, the API might return a few security questions to complete the identity verification process. The identity verification is done based on the user's response to the questions. | ||||
Method: | GET | ||||
URL: | {{baseUrl}}/services/data/v1/Thirdparty/operations/IDV/executeIDV | ||||
Security Level: | Authenticated App User | ||||
Header Request: |
X-Kony-Authorization |
||||
Payload: | jsondata={"ApplicantType":"Applicant","ProgressStatus":"Done"} | ||||
Body Request: |
Parameters ApplicantType (Mandatory) Specifies the type of applicant (Applicant/Co-applicant). { "ApplicantType": "Applicant", "ProgressStatus": "Done" } |
||||
Response: |
![]() Parameters Specifies the email address of the applicant. /IdNumber Specifies the entity definition key. /PersonalInfo_id Specifies the ID of the personal info of the applicant. /MobileCountryCode Specifies the mobile country code. /idType Specifies the ID type of the applicant. /IssuedDate Specifies the date on which the ID was issued. /ApplicantType Specifies the type of the applicant. /Zipcode Specifies the zipcode of the applicant. /IssuedState Specifies the state in which the ID was issued. /DateOfBirth Specifies the date of birth of the applicant. /FirstName Specifies the first name of the applicant. /City Specifies the city of the applicant. /isVerificationRequired Specifies whether verification for the answers is required or not. /AddressLine2 Specifies the address of the applicant. /MobileNumber Specifies the mobile number of the applicant. /AddressLine1 Specifies the address of the applicant. /ExpirationDate Specifies the expiration date of the issued ID. /State Specifies the state of the applicant. /IssuedCountry Specifies the country in which the ID was issued. /TaxIdNum Specifies the Tax identification number. /IdNum Specifies the Identification number. /Country Specifies the country of the applicant. /LastName Specifies the last name of the applicant. ![]() {"Email": "shivang.mishra@temenos.com", "IdNumber": "4567", "MobileCountryCode": "+91", "Gender": "", "IDType": "Driver License", "opstatus_GetAddressInfoOperation": 0, "opstatus_ExecuteIDVWithVendorOperation": 0, "isExistingCustomer": "No", "IssuedDate": "", "Zipcode": "560030", "ID": "625804ce3c6f4b1943555721", "IssuedState": "", "DateOfBirth": "1998-05-20", "FirstName": "Shivang", "Title": "", "index": "", "City": "Bengaluru", "MiddleName": "", "isVerificationRequired": false, "AddressLine2": "", "MobileNumber": "9790727039", "Type": "Owner", "AddressLine1": "Adugodi", "ExpirationDate": "2024-04-20", "opstatus_GetIdentityInfoOperation": 0, "State": "IN-KA", "IssuedCountry": "", "TaxIdNum": "1234", "opstatus": 0, "Country": "IN", "LastName": "Mishra", "AddressType": "", "opstatus_GetPersonalInfoOperation": 0, "httpStatusCode": 0 } |
||||
Error Code(s): |
|
||||
Service Flow: |
|

Description: | Verifies the response or answers that are provided by the user to the identity verification questions by leveraging the IDology service. | ||||
Method: | GET | ||||
URL: | {{baseUrl}}/services/data/v1/Thirdparty/operations/IDV/verifyResponse | ||||
Security Level: | Authenticated App User | ||||
Header Request: |
X-Kony-Authorization |
||||
Body Request: |
Parameters ApplicantType (Mandatory) Specifies the type of applicant. Application_id (Mandatory) Specifies the entity definition key. DateOfBirth (Mandatory) Specifies the date of birth of the applicant. responses (Mandatory) Specifies an array of response that includes question and its answer. question (Mandatory) Specifies a question. answer (Mandatory) Specifies an answer. //Applicant Case { "ApplicantType": "Applicant", "Application_id": "MBLL7FF", "DateOfBirth": "1975-02-02", "responses": [ { "question": "person.not.known", "answer": "DAVID BROWN" }, { "question": "city.of.residence", "answer": "ATLANTA" }, { "question": "ssn.digits.start", "answer": "69" }, { "question": "previous.address", "answer": "4344 BACKTRAIL DR" } ] } //Co-Applicant Case { "ApplicantType": "CoApplicant", "Application_id": "GTA231", "responses": [ { "question": "current.county.b", "answer": "ESMERALDA" }, { "question": "person.known.fic", "answer": "LISA MCKITRICK" }, { "question": "purchased.property.from", "answer": "CHRIS THOMAS" }, { "question": "ssn.digits.start", "answer": "48" } ] } |
||||
Response: | { "httpStatusCode": 200, "opstatus": 0, } |
||||
Error Code(s): |
|
||||
Service Flow: |
|

Description: | This API allows to get the Token | |||||
Method: | POST | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/IDV/getToken | |||||
Security Level: | Anonymous App User | |||||
Header Request: |
|
|||||
Body Request: | { } |
|||||
Response: | { "AccessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEODBCRUNEMzc0NDc3OUExQzcyNzY3NkREMjRCQzE5QzNCMzI4QjQiLCJ0eXAiOiJKV1QifQ.eyJuYW1laWQiOiI2YzE5YTIzMi02YzBmLTQyM2QtYjZhZC0wNmQzYzY3ZjdhN2EiLCJ1bmlxdWVfbmFtZSI6InYucGhhbmVlbmRyYUB0ZW1lbm9zLmNvbSIsImN1c3RpZCI6ImE2MjQ4NmJlLTcwNjUtNDlmMy1hYzFiLTg5ZWNkYjE0MGYyNSIsImN1c3RudW0iOiJUZW1lbm9zVUsiLCJyb2xlIjpbIkFkbWluaXN0cmF0b3IiLCJUcmFuc2FjdG9yIiwiQ29uZmlndXJhdG9yIiwiU2l0ZSBPcGVyYXRvciIsIkFQSSBLZXkgTWFuYWdlciIsIkdldElERG9jdW1lbnQgVHJhbnNhY3RvciIsIkdldEJpb21ldHJ5IFRyYW5zYWN0b3IiLCJGb3JlaWduIEFQSSBJbnRlZ3JhdG9yIl0sIm5iZiI6MTY2OTI3MzAwOCwiZXhwIjoxNjY5MjczOTA4LCJpYXQiOjE2NjkyNzMwMDgsImlzcyI6Imh0dHA6Ly9pcHNpZHkuY29tIiwiYXVkIjoiaHR0cDovL2N1c3RvbWVyLmlkY29tcGxldGUuaXBzaWR5LmNvbSJ9.hmksrcITjDHh-8suxlY8GM1_kVjsvEJ12uEKj9mKUSy4AgKjGmQ0auW01nzVlW4iGnjX19uAMHCNNm7xbEqEj37QPhG4F_B6mE8FYK5ChYkUguTUqKDIAW5P8xWel338TgZmWLCM8B_1cwkLiqW_KYDcg5V4qyU5Z7ju5fwl7txkCFpPBrhVnVRjG_tt8XjsF7Ag_f40P9tDJFnRF7M0x0lBJlfH0agfX23IxmLsAZ8ZZZ4Nd3WpwIOP-Y4JnUwlctinYhoquhWY4XfTmXzB0zsnkmxtKaqscNex2zcQnNlClZvQGjC0UqEt06rZBm8f6aSWfjS3tiMBAiBBBiF3wA", "AccessTokenExpirationDate": "2022-11-24T07:11:48.3550374Z", "ExpiresIn": "20221124071148", "RefreshToken": "gh8gKWW/wU3mtJnzcmIQnLMS8NUrcAfqik6ZdBu+wFO8fxBjP/QBSY4Nduj4gU2b", "TokenType": "Bearer", "UserExternalId": "6c19a232-6c0f-423d-b6ad-06d3c67f7a7a" } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | This API allows to initiate the document. | |||||
Method: | POST | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/IDV /initiateDocument | |||||
Security Level: |
Anonymous App User |
|||||
Header Request: |
|
|||||
Body Request: | { "DocumentTypes": "5", "PhoneNumber": "1321321", "Email": "xxx@xxx.xx", "IntroductionText": "" } |
|||||
Response: | { "AuthID": [ { "OperationID": "0e0bc234-570c-1bc9-82c0-48530ad1f29e", "OneTimeSecret": "4coRMketWaA71kPLHCGyI4Hg", "StartDate": "2022-11-24T09:26:56.96", "Status": 0 } ], "opstatus": 0, "httpStatusCode": 200 } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | This API allows to get the document status. | |||||
Method: | GET | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/IDV /getDocumentStatus | |||||
Security Level: |
Anonymous App User |
|||||
Header Request: |
|
|||||
Body Request: | { } |
|||||
Response: | { { "AuthID": [ { "EndDate": "2022-11-17T09:40:22.127", "Message": "Operation has been accepted by user.", "OneTimeSecret": null, "OperationId": "2af04735-d659-8c47-70de-09e7b570b789", "StartDate": "2022-11-17T09:38:26.883", "Status": 1, "TempId": "59233cae-b19b-449f-a289-2878037227c2" } ], "opstatus": 0, "httpStatusCode": 200 } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | This API allows to get the document details. | |||||
Method: | GET | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/IDV /getDocumentDetails | |||||
Security Level: |
Authenticated App User |
|||||
Header Request: |
|
|||||
Body Request: | { } |
|||||
Response: | { "Data": [ { "BiometryProcessingResult": "{Error=null, ErrorId=null, IsLive=true, LivenessCheckPerformed=true, LivenessScore=100, Processed=true, Quality=88}", "Document": [ { "Data": [ { "Key": "FinalCheckDigit", "Value": "8" }, { "Key": "RemainderTerm", "Value": "21" }, { "Key": "IssuingStateName", "Value": "United States" }, { "Key": "Age", "Value": "44" }, { "Key": "SecondaryIdentifier", "Value": "MAXIM" }, { "Key": "PrimaryIdentifier", "Value": "UMAROV" }, { "Key": "RawMrz", "Value": "P<USAUMAROV<<MAXIM<<<<<<<<<<<<<<<<<<<<<<<<<<^4885693324USA7708198M2312226259291785<474218" }, { "Key": "OptionalDataCheckDigit", "Value": "1" }, { "Key": "OptionalData", "Value": "2592917854742" }, { "Key": "DateOfExpiryCheckDigit", "Value": "6" }, { "Key": "Sex", "Value": "M" }, { "Key": "DocumentCode", "Value": "P" }, { "Key": "IssuingStateOrOrganization", "Value": "USA" }, { "Key": "NameOfHolder", "Value": "UMAROV MAXIM" }, { "Key": "DocumentNumber", "Value": "488569332" }, { "Key": "DocumentNumberCheckDigit", "Value": "4" }, { "Key": "Nationality", "Value": "USA" }, { "Key": "DateOfBirth", "Value": "1977-08-19" }, { "Key": "DateOfBirthCheckDigit", "Value": "8" }, { "Key": "DateOfExpiry", "Value": "2023-12-22" }, { "Key": "MrzType", "Value": "ID-3" }, { "Key": "IssuingAuthority", "Value": "United States^Department of State" }, { "Key": "Observations", "Value": "SEE PAGE 51" }, { "Key": "NationalityName", "Value": "UNITED STATES OF AMERICA" }, { "Key": "PlaceOfBirth", "Value": "RUSSIA" }, { "Key": "DateOfIssue", "Value": "2013-12-23" }, { "Key": "AgeAtIssue", "Value": "36" }, { "Key": "YearsSinceIssue", "Value": "8" }, { "Key": "recognitionStatus", "Value": "VALID" }, { "Key": "mrtdVerified", "Value": "True" } ] } ] } ], "Metadata": [ { "BiometricVerificationResult": [ { "Score": "49", "Verified": "true" } ] } ], "opstatus": 0, "httpStatusCode": 200 } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|

Description: | This API allows to update the selfie score in ODMS. | |||||
Method: | GET | |||||
URL: | {baseURL}/services/data/v1/Thirdparty/operations/IDV /updateSelfieScoreandResult | |||||
Security Level: |
Anonymous App User |
|||||
Header Request: |
|
|||||
Body Request: | { "SelfieScore": "70", "SelfieResult": "Passed", "LivenessSelfieScore": "70", "LivenessSelfieResult": "Passed", "FarSelfieResult": "Passed", "SectionProgress": "Done", "ApplicantType": "Applicant", "ConsentIdentifier": "Create_IDScan_Consent", "AcceptanceStatus": "Yes" } |
|||||
Response: | { "opstatus": 0, "httpStatusCode": 200 } |
|||||
Error Code(s): |
|
|||||
Service Flow: |
|
In this topic