This article provides the decoded assertion response and the ability to call the getAssertion function. The assertion response displays the metrics that determine acceptance, rejection, or manual review decisions via the Instant engine.
It authenticates information per customer, such as first name, last name, phone number, email, and more. It includes data and metadata about the enrolling device, biometric behaviors, geolocation, network cohort analysis, KYC, and document verification outcomes.
API Endpoints
| Environment | Location |
|---|---|
|
Production |
https://api.instnt.org/public/getassertion/v1.0 |
|
Pre-Prod |
|
|
Integration Sandbox |
https://sandbox-api.instnt.org/public/getassertion/v1.0 |
The getAssertion API accepts an instnttxnid value as the input to the API as follows:
{
"instnttxnid": "460e4f0e-40ad-4334-92ad-5f3173a6ffb1"
}
An instnttxnid is shorthand for an Instnt Transaction ID. To find the correct transaction ID, navigate to the Transaction Review page via Instnt Dashboard, and enter the specific transaction ID into the above field value. See the Transaction Review guide here.
See the UI for this API endpoint here.
GetAssertion POST
These examples use a curl request to perform the POST. A JSON payload is used to pass via the getassertion.json input file with the API response to return an encrypted JWT of the entire transaction assertion.
-
% curl -si -H 'content-type: application/json' https://
sandbox-api.instnt.org/secure/ getassertion/v1.0 -d @getassertion.json
HTTP/2 200
date: Fri, 10 Jul 2020 01:59:32 GMT
content-type: application/jwt
content-length: 4905
x-amzn-requestid: 7d948820-c8a6-4ff1-b997-916dfbffc45b
access-control-allow-origin: *
access-control-allow-headers: Content-Type
x-amz-apigw-id: Pby8jHKDIAMFnMw=
access-control-allow-methods: OPTIONS,POST,GET
x-amzn-trace-id: Root=1-5f07cb83-f175dac7a22e34563acb4384; Sampled=0
eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ. A7qRMYNxeZcI2TRMXzTTG3ZZL2OP6_ EOoSfymeNwZzX7MF9U7wu5LFM3LiKi YrkbJh56fEInVN3v0KY_ UqmFb2JpKKSnpssHexeISOSiEcD0L8 10TQPk8qTPrz0V1R8qjnexTX8D_ xSMhNYngze4-D9wyxOt9j- wRqovFq2vNGFDA0Y7JKkyyjZ6ptxGC zxsYDhCacnJDzr7VSA8JJQDz6lFTr- 7hI3av4CJBtpH- ieHCNikVA7bMUIFWgjPF7UIbvs4CK6 D_ 6LobYyBnYKGH7lPA4iwutCO9BC1j5N t6WTvfPv6fN5AnEuWSV0qQlzrV99oH 8y5K2zm- AR6ipToI57DQJ8HoK0NF8dYx83U3ua a5tFYBXOyCHKEUN- VetHdbMwVQJBG2vPkN6dYBCxTqs3HR EDTPtefqa21ElGWms1UF8wAe6aF80C G4ByL4s-O1IMsR3Dg3bvDy2eO5Rl- 7sQWhdgaajC3rin1xEU1FrPNl- tuvRPrTY9ZyPq0AMa8KGh88wDfoN4e rqgUpOQ6o22YoeM2WPEkzYq0bTD0M9 XCKCq8jzmLN2H1cXzrBuazHpvfMa9v x_ZD1ssTeAj5Gh_ O0g18GDiFRtjXg0mQ3Cbq8wIXNQLcG 1Mewb9QhC478e088vLxhVV9dkznnj3 BpuZhzwakQNyxcOv0Jczp7Ss. cWnYUp-OqDXfXw2l.I05i_ 8YfWLEbn3NE99g2RD5G5XsOZQG26mC BVlFrWFH4weC5l7BJJQR5xYIyUwDwL WOIjccY2ER7xys5_ S7a3Vgi035WANr4VSUd16h2EMvuJvM zqtqPVnXvf_ 7ETKcWnO4vMB65xSI9t5vH13Lc9K8- BOh1loeGWVxCb9riLBWPewPDQGchTL 5pZs_ 1cUC57jxvvq39M4xHD3nJnq9fMMdO8 hr4kH0BuhPo4oOL_ Id5s4gWJXZcyV6bNNpIO7PtqjSecmQ v6_PXyJS7df9W972bvs8MoKt- cYep9vjrROFxwiKHhzN0X8BljVmRHV whkZPf7YEOg6U9IMCyYe3v4Rl134fw hTezDy93DkbbxzYOBtbpPR9ovIaezQ RsGBcfnaliYz3cGmWgawj4bHr_ QcjD_ wd2VjKmNO7Gxoan8a1njo5UuqHuSF2 gq2Hj6CvV- 1VkDXv7GPG7ItHgUWAWCasRIP- 3UHa1aFuGc7fgkoRSRxZal6SE1r5aJ DiyX- rj0ZZPPjxJK0RYGbtq9evJweQJscRY 5EGuHAiDrmVoNvO_ qrUJyZnwWS1NFJTZUqwexmTUKqEm0l rC26q3agBZTbALcax9QTQdjTIaBS- h-L9CsCw71qy3CslRu-7yL4vn- qhEU95hpvuM41xES311zTNPR_ SPCGWbMHHssu8ZTfT7FtZKFUhCTZgL xmRSvGm-74MnsW6_ Ly1oxscg4u5n21iMWiIZYW_ zRiPuGRQiltFbA_ UM3E6r1BfXsMcqWz0W3s5ty72u5T_ RdKxe9E- G9lPWXOYxyJI3fuPSrcj73WgFRqban s_kgXhLsDmgWqLJ7HO1sZ2r- PxMD1x7NP0H-tMMu1nGcdjEz0a_ vdGa9MRcXrEiAvHImANFVwbvN6xC6P S-YThxHhQKn7xlb9eSD-u24ih- YN9e4lsmPrKHveChy94EeJe0cfscuI rzgWS4R02U6BrZC5Hqt7osWdmvUrEZ BGq-MF5QG- kJ1kzYVj2PgC7ddBGSBMlrp1vQxpF4 ZAplHWj-SJ8OJGL7jetLCYU0S9- wb35FSsJ9L_ Biobx157AvtYvxx8giI9-yFINDb6A_ q7zMiUt9fOowvCsNbmBSHUHR2T_ F4PGwWnma8fBLl7CVS7XN1JMTOe9Xx BURjG3hgQF3BHFp_saBb1qn- 2nFS78BMRZRkf8XwxEKm1E8CFDLISs JvoE8Hb-uwzya0_IDiy6_ P9jLrJNuKur7aXBg9vibIuA1eyZbdz IhDK0ie1ay49onqkwCLkuF_ 77fxFPMDJNm6R1EURnFl1J3GC36YXG bZJr3V-E1j3_ 1Mid9szAv2n8K5H1OnPzmUNJkvX_ 2LpBl98cArfNrNFaMrsw- 2ZSyvEzFVN6b4PQ8528Da0W9wP9Hol iVuRvzAquw8GDn0cULkgh8- 3ps9nKZ- dxpdDhTPMTdmdMQDXazMNthoCoSn40 1cRhOJKp2sOmYnCDYqjyytrEd- Z2Cr8zRvf- KTfgxXLob3MSjkrmuL07rZrEgu32wn Iq9pIS_ 5Evgn0nP0gpqx7X5yybI3VFHdJ2a2e DokE3JhLJGEacdg6AEqZaENgaJMh6b yWs_9ddAqOx9PxNb0q2CO- YQ2wMsuGKO4h0kwADZ63FEIBVjEOzG dtBMuf7VejucKPTLPb8Xf_ HpzG3XOILfbvXlvdIoAdIWuiHF3_ 6YvXOVGgArfZvxuK1qGzLjD78blDFg sgMBGpIlKz8IKGfgm76kWsNR9l2mjY nRaS7er7OY-6dbJG91HfKjIWNG-S_ PqeVlS9DkGAyrdJn2QxBb668BtAtw_ k95wv4nBB9qCJ9yTamj3pEYGYqK_ XS6VrbTvCzfCyyxmjV5wzcssc25bDK NVxsxqFJlRhzOxLKqr_5TYCtn- 2esT- oW7MlWgf1KspelN1W2AZEUCxvM3Gfo h-TodGRz_Qsf77Dy8Ts9NWfW2- 8EYKxwZVyk3pc42lvTZ5p9lHJOQqbp jHrfO5toPOqcMPX8CbnAUV2UH1JpUo fCSdU6Odh8EB7Wl7HbtWZR4T87iTW_ FtOG6KChQJ0BCrai-O-fB3yzpkOEM- 1bX7joES3fK6T7LY7Ttfn5q- tiGv48fF4UDzPmnnzKHYdZ6hTRSwfY YXDjOFEyOBAQDPhMwTJDt0gTcxiwBv V8V- Ta1V677xj1lN0bnCHDM6omZL6bV76- I7cCpLaLWvHStPceMgVZ- beknHyFCjOOMyqvSOclJ2oMcMv4Ir5 eWrHsc6BADnKuO1S4tvutRRPxOgsDx nhYLTETHjMZxwa4nBRV7Tsf7PkZ5Pk Jv26f16-- 8z4y8VWKeJuhLatzmWI0tOQqjZVrUn PbQffnYNyFE0a00f8iE6fGEtSy- n3AV_ fcSPW3jurVUzSv541SXGpOw4EuqsbW GJfmnSfcM89JkdPc- diYCKMd5RzaO6l_ NHHFv5tExRwtmj5- 1vSMRBabb7As7K6_ axRQmYR4FWHkWIR_vH2lS_ nPb0zFaWGAf8KBbC- wxPX8Y6bD0WGd0WqRc_C70- 0YV8eBVB9OPEgV991FjtUF4Rt4TELi bwS_ NYOWRt5mRjkGSFeCPjR2iQO7hE1y0P ktU2lY9Pz6GIOD58hFL6N88VFrUl4A r- cT75jgryVgZ998Dsz5aLED9bySPcUf i4C0KoV_ SuwzchM3NDZ4abimeAnxwYr4MqMCVR bIaJSPPazivV9SKZoA6woW2R_ A10Lmv_ i3uELUON2dET0lsv2pDgcpw7gxdNGb EXmvnWf7de8fmnEAmwhvuNgLbAs59a SC5bHjEw90WFy0- MypT8mNrE17Tz5u6ODjiU0x2Lc0Yvd QtIvNMk8lzDom10pRxD6q5Lxe4d8An Neil3JowJ4xBKPFU6jinLEsjczKA0Z 5RNlR5EFsSicHsh0a1y4yLRVLePU7N itW6ONvDo4XE3Q5taqEyZW9nXy7Nvy QBqNrU02oyITikfvH0qn06Epsvl2jb 8ku3lhSWEkzn8_pd6dwRELO82e- GhbxF74w- mnMNe1KNwqdtAPIxgID3eIY_ HoLVDxNDosVKlPGNotCKoLdqfOfQIR wKJ_ NBRbRTVjH87unEKlBtyMirbdmEzvUd h2wucHHBLqU9PA2AxU5rEWnhMuEkHc gZWFPH8usqCoMmWW3D1D7mlX6qYmpX 2j2UZyf9crTWp81KRl055wetRwZbAl 3gAdX7vTbL37-BdcdbSWH99sH_mio- U4aJz3wD- gWllECEvYayK9ukC4TirVArpOdM7rX DXXTgK4HFzujClxfN3- ZgGGhzPKVAhtk4bckUCtsNCNAAC1ye 4MUjbapN4LWPLcbAy92GBkmxUCOsxi - 9QJrGPv46eOtgOPDx9fVchsGHGwGip pi31qd1gaCVfX3ZN0keAGtWiexDVRf yGw0mgSbYt6nwbcPQGetERWnsxsmis VaeQfE9usK4S1CSqn8GEH3CYWjGLuy v1aSwL5euZ3thotO1tAwThWJw7ZPLh B_ juhhpoKxhGa1koyFTDCWVv5fw6H7dY Tkl-hiukvjtgOaVUvAV4CJN_ ppg5BNwO3ftFr1HNOpGlnmwtr53Cra mEBNiMOH-lJz9- ObsohJTZaNeGHWDvM2Yk6MsFmsDc_ gpyTPuyvEq- nw7iGs3FtiZFYdRxs8REpmCajVielC 8lwd3raWw8lae-W8DATMyAKBA- 0nBsVTMahAHgGsHHKQiaJYa2jVKEF8 luaRbSRS6Dss3ciW4ozuUN1mMWVO1R cAt-c1x8sce8AYxGx- KMCQ7Rq1mvAMNIIjhNqghd5y5anlRA Ef_u7a0jG7_RxscPk- 0rXorinI3gMWF- 1Dezi9GPuVaSVTkKp3LYa8ASPEVG9T RyEemJZ5pD_ Zopr2wOwLWBe2XRpW1slQvtjZ- WzBaOFcvD2uigstPNzfVS3BK1NuJGw QLR7OJXRMkH8RJ3a5OMN2sPJgVhvvc Kt5AwbW92xtwUgVLkwqoZKnI1TNNw9 O3PE9FwMno9DDCCCXzh_ wDWfJeijDok-f4umKtsXEDnC- 98aCfM- iFTtBkhnlzod0uxURkqIESmMuM7wf- yheTM6PpSDZYh_ FRXZ8yOT6yZuX1FwpUtswaFGZZMiUO wipOyHzv5CbXRejNw.VdKUz_ aZMih06pg4JiqxkQ -
% curl -si -H 'content-type: application/json' https://api.instnt.org/secure/
getassertion/v1.0 -d @getassertion.json
HTTP/2 200
date: Fri, 10 Jul 2020 01:59:32 GMT
content-type: application/jwt
content-length: 4905
x-amzn-requestid: 7d948820-c8a6-4ff1-b997-916dfbffc45b
access-control-allow-origin: *
access-control-allow-headers: Content-Type
x-amz-apigw-id: Pby8jHKDIAMFnMw=
access-control-allow-methods: OPTIONS,POST,GET
x-amzn-trace-id: Root=1-5f07cb83-f175dac7a22e34563acb4384; Sampled=0
eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ. A7qRMYNxeZcI2TRMXzTTG3ZZL2OP6_ EOoSfymeNwZzX7MF9U7wu5LFM3LiKi YrkbJh56fEInVN3v0KY_ UqmFb2JpKKSnpssHexeISOSiEcD0L8 10TQPk8qTPrz0V1R8qjnexTX8D_ xSMhNYngze4-D9wyxOt9j- wRqovFq2vNGFDA0Y7JKkyyjZ6ptxGC zxsYDhCacnJDzr7VSA8JJQDz6lFTr- 7hI3av4CJBtpH- ieHCNikVA7bMUIFWgjPF7UIbvs4CK6 D_ 6LobYyBnYKGH7lPA4iwutCO9BC1j5N t6WTvfPv6fN5AnEuWSV0qQlzrV99oH 8y5K2zm- AR6ipToI57DQJ8HoK0NF8dYx83U3ua a5tFYBXOyCHKEUN- VetHdbMwVQJBG2vPkN6dYBCxTqs3HR EDTPtefqa21ElGWms1UF8wAe6aF80C G4ByL4s-O1IMsR3Dg3bvDy2eO5Rl- 7sQWhdgaajC3rin1xEU1FrPNl- tuvRPrTY9ZyPq0AMa8KGh88wDfoN4e rqgUpOQ6o22YoeM2WPEkzYq0bTD0M9 XCKCq8jzmLN2H1cXzrBuazHpvfMa9v x_ZD1ssTeAj5Gh_ O0g18GDiFRtjXg0mQ3Cbq8wIXNQLcG 1Mewb9QhC478e088vLxhVV9dkznnj3 BpuZhzwakQNyxcOv0Jczp7Ss. cWnYUp-OqDXfXw2l.I05i_ 8YfWLEbn3NE99g2RD5G5XsOZQG26mC BVlFrWFH4weC5l7BJJQR5xYIyUwDwL WOIjccY2ER7xys5_ S7a3Vgi035WANr4VSUd16h2EMvuJvM zqtqPVnXvf_ 7ETKcWnO4vMB65xSI9t5vH13Lc9K8- BOh1loeGWVxCb9riLBWPewPDQGchTL 5pZs_ 1cUC57jxvvq39M4xHD3nJnq9fMMdO8 hr4kH0BuhPo4oOL_ Id5s4gWJXZcyV6bNNpIO7PtqjSecmQ v6_PXyJS7df9W972bvs8MoKt- cYep9vjrROFxwiKHhzN0X8BljVmRHV whkZPf7YEOg6U9IMCyYe3v4Rl134fw hTezDy93DkbbxzYOBtbpPR9ovIaezQ RsGBcfnaliYz3cGmWgawj4bHr_ QcjD_ wd2VjKmNO7Gxoan8a1njo5UuqHuSF2 gq2Hj6CvV- 1VkDXv7GPG7ItHgUWAWCasRIP- 3UHa1aFuGc7fgkoRSRxZal6SE1r5aJ DiyX- rj0ZZPPjxJK0RYGbtq9evJweQJscRY 5EGuHAiDrmVoNvO_ qrUJyZnwWS1NFJTZUqwexmTUKqEm0l rC26q3agBZTbALcax9QTQdjTIaBS- h-L9CsCw71qy3CslRu-7yL4vn- qhEU95hpvuM41xES311zTNPR_ SPCGWbMHHssu8ZTfT7FtZKFUhCTZgL xmRSvGm-74MnsW6_ Ly1oxscg4u5n21iMWiIZYW_ zRiPuGRQiltFbA_ UM3E6r1BfXsMcqWz0W3s5ty72u5T_ RdKxe9E- G9lPWXOYxyJI3fuPSrcj73WgFRqban s_kgXhLsDmgWqLJ7HO1sZ2r- PxMD1x7NP0H-tMMu1nGcdjEz0a_ vdGa9MRcXrEiAvHImANFVwbvN6xC6P S-YThxHhQKn7xlb9eSD-u24ih- YN9e4lsmPrKHveChy94EeJe0cfscuI rzgWS4R02U6BrZC5Hqt7osWdmvUrEZ BGq-MF5QG- kJ1kzYVj2PgC7ddBGSBMlrp1vQxpF4 ZAplHWj-SJ8OJGL7jetLCYU0S9- wb35FSsJ9L_ Biobx157AvtYvxx8giI9-yFINDb6A_ q7zMiUt9fOowvCsNbmBSHUHR2T_ F4PGwWnma8fBLl7CVS7XN1JMTOe9Xx BURjG3hgQF3BHFp_saBb1qn- 2nFS78BMRZRkf8XwxEKm1E8CFDLISs JvoE8Hb-uwzya0_IDiy6_ P9jLrJNuKur7aXBg9vibIuA1eyZbdz IhDK0ie1ay49onqkwCLkuF_ 77fxFPMDJNm6R1EURnFl1J3GC36YXG bZJr3V-E1j3_ 1Mid9szAv2n8K5H1OnPzmUNJkvX_ 2LpBl98cArfNrNFaMrsw- 2ZSyvEzFVN6b4PQ8528Da0W9wP9Hol iVuRvzAquw8GDn0cULkgh8- 3ps9nKZ- dxpdDhTPMTdmdMQDXazMNthoCoSn40 1cRhOJKp2sOmYnCDYqjyytrEd- Z2Cr8zRvf- KTfgxXLob3MSjkrmuL07rZrEgu32wn Iq9pIS_ 5Evgn0nP0gpqx7X5yybI3VFHdJ2a2e DokE3JhLJGEacdg6AEqZaENgaJMh6b yWs_9ddAqOx9PxNb0q2CO- YQ2wMsuGKO4h0kwADZ63FEIBVjEOzG dtBMuf7VejucKPTLPb8Xf_ HpzG3XOILfbvXlvdIoAdIWuiHF3_ 6YvXOVGgArfZvxuK1qGzLjD78blDFg sgMBGpIlKz8IKGfgm76kWsNR9l2mjY nRaS7er7OY-6dbJG91HfKjIWNG-S_ PqeVlS9DkGAyrdJn2QxBb668BtAtw_ k95wv4nBB9qCJ9yTamj3pEYGYqK_ XS6VrbTvCzfCyyxmjV5wzcssc25bDK NVxsxqFJlRhzOxLKqr_5TYCtn- 2esT- oW7MlWgf1KspelN1W2AZEUCxvM3Gfo h-TodGRz_Qsf77Dy8Ts9NWfW2- 8EYKxwZVyk3pc42lvTZ5p9lHJOQqbp jHrfO5toPOqcMPX8CbnAUV2UH1JpUo fCSdU6Odh8EB7Wl7HbtWZR4T87iTW_ FtOG6KChQJ0BCrai-O-fB3yzpkOEM- 1bX7joES3fK6T7LY7Ttfn5q- tiGv48fF4UDzPmnnzKHYdZ6hTRSwfY YXDjOFEyOBAQDPhMwTJDt0gTcxiwBv V8V- Ta1V677xj1lN0bnCHDM6omZL6bV76- I7cCpLaLWvHStPceMgVZ- beknHyFCjOOMyqvSOclJ2oMcMv4Ir5 eWrHsc6BADnKuO1S4tvutRRPxOgsDx nhYLTETHjMZxwa4nBRV7Tsf7PkZ5Pk Jv26f16-- 8z4y8VWKeJuhLatzmWI0tOQqjZVrUn PbQffnYNyFE0a00f8iE6fGEtSy- n3AV_ fcSPW3jurVUzSv541SXGpOw4EuqsbW GJfmnSfcM89JkdPc- diYCKMd5RzaO6l_ NHHFv5tExRwtmj5- 1vSMRBabb7As7K6_ axRQmYR4FWHkWIR_vH2lS_ nPb0zFaWGAf8KBbC- wxPX8Y6bD0WGd0WqRc_C70- 0YV8eBVB9OPEgV991FjtUF4Rt4TELi bwS_ NYOWRt5mRjkGSFeCPjR2iQO7hE1y0P ktU2lY9Pz6GIOD58hFL6N88VFrUl4A r- cT75jgryVgZ998Dsz5aLED9bySPcUf i4C0KoV_ SuwzchM3NDZ4abimeAnxwYr4MqMCVR bIaJSPPazivV9SKZoA6woW2R_ A10Lmv_ i3uELUON2dET0lsv2pDgcpw7gxdNGb EXmvnWf7de8fmnEAmwhvuNgLbAs59a SC5bHjEw90WFy0- MypT8mNrE17Tz5u6ODjiU0x2Lc0Yvd QtIvNMk8lzDom10pRxD6q5Lxe4d8An Neil3JowJ4xBKPFU6jinLEsjczKA0Z 5RNlR5EFsSicHsh0a1y4yLRVLePU7N itW6ONvDo4XE3Q5taqEyZW9nXy7Nvy QBqNrU02oyITikfvH0qn06Epsvl2jb 8ku3lhSWEkzn8_pd6dwRELO82e- GhbxF74w- mnMNe1KNwqdtAPIxgID3eIY_ HoLVDxNDosVKlPGNotCKoLdqfOfQIR wKJ_ NBRbRTVjH87unEKlBtyMirbdmEzvUd h2wucHHBLqU9PA2AxU5rEWnhMuEkHc gZWFPH8usqCoMmWW3D1D7mlX6qYmpX 2j2UZyf9crTWp81KRl055wetRwZbAl 3gAdX7vTbL37-BdcdbSWH99sH_mio- U4aJz3wD- gWllECEvYayK9ukC4TirVArpOdM7rX DXXTgK4HFzujClxfN3- ZgGGhzPKVAhtk4bckUCtsNCNAAC1ye 4MUjbapN4LWPLcbAy92GBkmxUCOsxi - 9QJrGPv46eOtgOPDx9fVchsGHGwGip pi31qd1gaCVfX3ZN0keAGtWiexDVRf yGw0mgSbYt6nwbcPQGetERWnsxsmis VaeQfE9usK4S1CSqn8GEH3CYWjGLuy v1aSwL5euZ3thotO1tAwThWJw7ZPLh B_ juhhpoKxhGa1koyFTDCWVv5fw6H7dY Tkl-hiukvjtgOaVUvAV4CJN_ ppg5BNwO3ftFr1HNOpGlnmwtr53Cra mEBNiMOH-lJz9- ObsohJTZaNeGHWDvM2Yk6MsFmsDc_ gpyTPuyvEq- nw7iGs3FtiZFYdRxs8REpmCajVielC 8lwd3raWw8lae-W8DATMyAKBA- 0nBsVTMahAHgGsHHKQiaJYa2jVKEF8 luaRbSRS6Dss3ciW4ozuUN1mMWVO1R cAt-c1x8sce8AYxGx- KMCQ7Rq1mvAMNIIjhNqghd5y5anlRA Ef_u7a0jG7_RxscPk- 0rXorinI3gMWF- 1Dezi9GPuVaSVTkKp3LYa8ASPEVG9T RyEemJZ5pD_ Zopr2wOwLWBe2XRpW1slQvtjZ- WzBaOFcvD2uigstPNzfVS3BK1NuJGw QLR7OJXRMkH8RJ3a5OMN2sPJgVhvvc Kt5AwbW92xtwUgVLkwqoZKnI1TNNw9 O3PE9FwMno9DDCCCXzh_ wDWfJeijDok-f4umKtsXEDnC- 98aCfM- iFTtBkhnlzod0uxURkqIESmMuM7wf- yheTM6PpSDZYh_ FRXZ8yOT6yZuX1FwpUtswaFGZZMiUO wipOyHzv5CbXRejNw.VdKUz_ aZMih06pg4JiqxkQ
Error Codes Response
| Code | Description |
|---|---|
| 200 | Ok |
| 400 | Bad Request |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 408 | Request Timeout |
How Assertion Response Works
When customer signup is processed, Instnt processes a decision callback redirect response to redirect the customer into your application onboarding workflow.
This reference takes the form of an instntjwt parameter passed as a JSON Web Token on the HTTP redirect you define.
The response is signed and encrypted using your public PKI key. Only when supplied by your business and signed by Instnt.
Instnt sends our public key to validate the signature via email to verify the assertion payload is only visible to the customer- to guarantee that the assertion originated from Instnt.
- The assertion is returned from the API Gateway as a signed and encrypted JWT token with the following header:
-
{'alg': 'RS256', 'typ': 'JWT'}
- The example code block is what the payload displays once the assertion decrypts:
-
{"id":1, "instnttxnid":"aabbc-1234-asdasd-4014-caxc1", "form_key_formaudit":"v12345", "form_key_doc_verify":null, "instnttxntimestamp":"2022-09-09T16:19:12.853157Z", "instntuserid":212, "instntapiversion":"1.4.5", "form":{ "dob":"1900-01-01", "zip":"12345", "city":"New York City", "email":"abc@abc.org", "state":"NY", "surName":"Doe", "form_key":"v12345", "client_ip":"127.0.0.1", "firstName":"Jo", "userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36","expires_on":"1662743739", "nationalId":"123-45-6789", "instnttxnid":null, "mobileNumber":"+123456789", "physicalAddress":"1 Main Street", "client_referer_url":"", "client_referer_host":""}, "device":{ "nativeDeviceDetails":{ "os":"Other", "osVersion":null, "botProbability":"0"}, "is_bot":false, "ipLocation":{ "country":{"name":"United States"}, "city":{"name":"New York City"}, "state":"NY", "postalCode":"12345","timezone":"America/Chicago","latitude":0,"longitude":0} }, "biometrics":{ "bot_Anomaly":false, "rat_Anomaly":false, "userCoached":false, "differIP":false, "flag_CorruptedSession":false, "flag_Whitelisted":false, "SessionRisk":0.35, "behavioralScore":0.5}, "documents":null, "model":[ {"name":"Aggregate Decision","version":"1.0.0","source":"internal","decision":"ACCEPT","overrideFlag":false,"overrideComments":null,"score":0,"thresholds":{"accept_min":0.0,"accept_max":0,"reject_min":1,"reject_max":1.0}}, {"name":"1st Party Fraud Model","version":"1.0.0","source":"internal","decision":"ACCEPT","overrideFlag":false,"overrideComments":null,"score":0.117011120695112,"thresholds":{"accept_min":0.0,"accept_max":0.5,"reject_min":0.86,"reject_max":1.0}}, {"name":"3rd Party Fraud Model","version":"1.0.0","source":"internal","decision":"REVIEW","overrideFlag":false,"overrideComments":null,"score":0.0218173367328576,"thresholds":{"accept_min":0.0,"accept_max":0.013,"reject_min":0.67,"reject_max":1.0}}, {"name":"Synthetic Fraud Model","version":"1.0.0","source":"internal","decision":"ACCEPT","overrideFlag":false,"overrideComments":null,"score":0.00897116046962712,"thresholds":{"accept_min":0.0,"accept_max":0.0275,"reject_min":0.59,"reject_max":1.0}}], "cohorts":{ "ip_frequency_24h":1, "name_frequency_24h":1, "phone_frequency_24h":1, "email_frequency_24h":1, "address_frequency_24h":1, "device_frequency_24h":0}, "kyc":null, "justification":{ "reason_codes":[ {"code":"CA104","description":"No hits on KYC watchlists, KYC pass","sentiment":"Positive"}, {"code":"DOB102","description":"DOB is verified with PII vendors","sentiment":"Positive"}, {"code":"EE100","description":"Email address is a personal address","sentiment":"Neutral"}, {"code":"EE102","description":"Email address is free","sentiment":"Neutral"}, {"code":"EN103","description":"Last Name may have changed in the past","sentiment":"Neutral"}, {"code":"PA101","description":"Address age > 180 days","sentiment":"Neutral"}, {"code":"PA102","description":"Physical address verified","sentiment":"Positive"}, {"code":"PA103","description":"City matches","sentiment":"Positive"}, {"code":"PE100","description":"Email matches","sentiment":"Positive"}, {"code":"PE101","description":"Email valid and mainDomain","sentiment":"Neutral"}, {"code":"PE102","description":"Email age > 180 days","sentiment":"Neutral"}, {"code":"PN101","description":"Name matches","sentiment":"Positive"}, {"code":"PP100","description":"Phone number matches","sentiment":"Positive"}, {"code":"PP101","description":"Phone number belongs to a Major Carrier","sentiment":"Neutral"}, {"code":"PP102","description":"Phone age > 180 days","sentiment":"Neutral"}, {"code":"SSN100","description":"SSN verified","sentiment":"Positive"}], "correlations":{ "NameEmail":100, "NamePhone":100, "PhoneEmail":100, "NameAddress":100, "AddressEmail":87, "AddressPhone":100, "NamePhoneEmail":100, "NameAddressEmail":95, "NameAddressPhone":100, "AddressPhoneEmail":95, "NameAddressPhoneEmail":97}}, "form_key":"v12345", "form_key_checkselfie":null, "ip":"REDACT", "decision":"ACCEPT"}
Note: The iss, exp, and iat are registered claim names per JSON Web Token. The assertion claim is an Instnt-defined custom claim.
Assertion Field Glossary
The following table is a collection of the relevant fields listed in the assertion response payload and their definitions:
| String | Definition |
| form | All field entries input by a customer in a signup form that are verified and cross-referenced back to the user's name are returned as features with risk ratings. |
| device | Device characteristics are fingerprinted to uniquely identify the device and returned as features with associates risk ratings. |
| assertion | Contains customer information, the decision on the customer, and the instntid. |
| kyc | Instnt's Know Your Customer compliance models for customer identification programs and customer due diligence including correlations and hits on watchlists such as OFAC, PEP etc. are returned. |
| biometrics | Passive user behaviors such as the way they type, press buttons etc. and cognitive behaviors such as how long they take to recollect their date of birth, whether they copied and pasted their date of birth etc. are analyzed and returned as features with associated risk ratings. |
| bot_Anomaly | The Bot Detection Flag indicates that robotic behavior was detected such as a typing rhythm that is too uniform or jittery mouse movements. |
| rat_Anomaly | The Remote Access flag indicates that one or more remote access protocols were detected in the session. |
| userCoached | The Coaching Detection flag indicates that the user has probably been coached to perform a transaction. |
| differIP | The IP Changed Flag indicates that the IP address changed during the active session or is different than the last 20 sessions. |
| flag_CorruptedSession | The Session Corrupted flag indicates that there was session level corruption, such as when a username changes during a session. |
| flag_Whitelisted | The Whitelisted flag appears on any session where a user has been designated as white-listed by an BehavioSense Administrator. |
| SessionRisk | Risk is a numerical measure of potentially fraudulent activity during the course of a session. The Risk level can be a number greater than or equal to zero. A Risk level in the range of 0 to 1 is considered minimal risk, while over 1 is considered high risk and should be investigated. |
| behavioralScore | Score (Behavioral Score) is a value ranging from 0 to 1. Score indicates to what degree the behavioral timing data in the session matches the behavioral timing data in the trained User Profile. A high Score means there is little difference between the timing data in the current session and that of the Profile, while a low Score means the behavioral timing data of the logged in user did not match the data stored in the Profile. |
| cohort_analysis | A comparison of model inputs for a specific user versus a cohort of users to see where they lie in the data. |
| hiddenIP | The Hidden flag appears on any session where the origin of the IP address has been hidden, such as when a TOR exit node or VPN was in use. |
| error | .jpg file submitted is an invalid file, submission was unable to complete. |
| exp | The "exp" (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing. The processing of the "exp" claim requires that the current date/time MUST be before the expiration date/time listed in the "exp" claim. |
| iat | The "iat" (issued at) claim identifies the time at which the JWT was issued. This claim can be used to determine the age of the JWT. Its value MUST be a number containing a NumericDate value. Use of this claim is OPTIONAL. |
| iss | The "iss" (issuer) claim identifies the principal that issued the JWT. The processing of this claim is generally application specific. The "iss" value is a case-sensitive string containing a StringOrURI value. Use of this claim is OPTIONAL. |
| models | The accept/reject/review decision made by Instnt's fraud detection models and the individual results from the model's assumptions are returned. |
| search_term | The name that is passed into the KYC search |
| match_status | Returns the status of the KYC match. "potential_match" if there is any match OR "no_match" if not |
| match_confidence | Give some relative indication of match relevance. Ranging between 0 and 100 |
| matched_media_urls | The url links of adverse media sources |
| matched_names | All possible names returned by the search |
| matched_entity_type | Whether the matched entity is a person or organization |
| matched_types_detail | Returns the detail of match types. It may be "name_exact", "aka_exact", "year_of_birth" based on the returned fields or "unknown" if the match is based on an acronym |
| matched_watchlist_types | Types of watchlists the name exists in such as "adverse-media" or "sanction" |
| matched_watchlist_sources | Specific sources of watchlists the name exists in |
| number_of_matches | The number of possible matches |
| reason_codes | A set of explanatory codes defining the reasoning for the decision within Instnt's fraud detection models are returned for justification purposes and compliance with model governance requirements. |
Document Authentication and Selfie Segment Names
The following table is a collection of the segment names listed in the authentication and matchselfie fields in the documents subsection of the assertion response payload and their definitions:
| Segment Name | Action Description |
| Verified | No rescan action suggested. Default Action Code. |
| Fraud Shield | Failed as matched to a Fraud Shield Watchlist |
| Recapture All | Rescan entire transaction |
| Recapture Selfie | Rescan Selfie |
| Recapture ID | Rescan ID front and back only |
| Expired ID | Try a valid ID (non expired) |
| Unsupported ID | Recapture All ID and Selfie Images |
| Potential Paper ID | Recapture All ID and Selfie Images |
| Failed | Failed transaction, but take no action |
| Submission Error | Recapture All ID and Selfie Images |
| Document did not pass ... checks | Rescan ID front and back. If ExpireDate is one of the checks failed, please rescan and/or use a valid non-expired ID |