At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.

POST

https://api.uat.frankie.one/v2/individuals/:entityId/actions/idv/process

POST

/v2/individuals/:entityId/actions/idv/process

1 curl -X POST https://api.uat.frankie.one/v2/individuals/entityId/actions/idv/process \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4      -H "api_key: <apiKey>" \
5      -H "Content-Type: application/json" \
6      -d '{}'

Try it

1 {
2   "status": "IN_PROGRESS",
3   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
4   "workflowExecutionId": "workflowExecutionId",
5   "ocrResult": {
6     "processResultId": "processResultId",
7     "schemaVersion": 1,
8     "entityId": "entityId",
9     "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
10     "stepName": "stepName",
11     "stepType": "stepType",
12     "objectType": "objectType",
13     "objectId": "objectId",
14     "createdAt": "2024-01-15T09:30:00Z",
15     "updatedAt": "2024-01-15T09:30:00Z",
16     "groupId": "groupId",
17     "providerResult": {
18       "name": "name",
19       "source": "source",
20       "sourceNormalized": "sourceNormalized",
21       "reference": "reference",
22       "fuzziness": {
23         "normalized": 1.1,
24         "actual": "actual"
25       },
26       "confidence": {
27         "normalized": 1.1,
28         "actual": "actual"
29       },
30       "riskScore": 1.1,
31       "errorCode": "errorCode",
32       "errorMessage": "errorMessage"
33     },
34     "result": "MATCH",
35     "class": "KYC",
36     "supplementaryData": {
37       "type": "AML",
38       "aliases": [
39         "aliases"
40       ],
41       "caseId": "caseId",
42       "fuzziness": {
43         "normalized": 1.1,
44         "actual": "actual"
45       },
46       "groupingId": "groupingId",
47       "matchData": {
48         "spReferenceId": "spReferenceId",
49         "name": "name",
50         "strength": 1.1,
51         "givenName": "givenName",
52         "otherName": "otherName",
53         "familyName": "familyName",
54         "date": "date",
55         "address": "address",
56         "countries": [
57           {
58             "code": "code",
59             "matchType": "matchType"
60           }
61         ],
62         "nationalId": {
63           "idNumber": "idNumber",
64           "idType": "idType",
65           "idExpiry": "idExpiry",
66           "issuingCountryCode": "issuingCountryCode",
67           "documentId": "documentId"
68         },
69         "imageUrl": "imageUrl",
70         "isDeceased": true,
71         "isAlias": true,
72         "isRelated": true
73       },
74       "mediaData": [
75         {
76           "title": "title",
77           "source": "source",
78           "snippet": "snippet",
79           "sourceDate": "sourceDate",
80           "sourceCountry": "sourceCountry",
81           "url": "url",
82           "isCurrent": true
83         }
84       ],
85       "notes": {
86         "key": {
87           "type": "type",
88           "value": "value"
89         }
90       },
91       "originalStepSearchLevel": "originalStepSearchLevel",
92       "pepData": [
93         {
94           "countryCode": "countryCode",
95           "countryName": "countryName",
96           "sourceName": "sourceName",
97           "level": "level",
98           "sourceUrl": "sourceUrl",
99           "position": "position",
100           "positionDescription": "positionDescription",
101           "status": "status",
102           "listingStart": "listingStart",
103           "listingEnd": "listingEnd",
104           "imageUrl": "imageUrl",
105           "referenceDocs": [
106             {
107               "url": "url",
108               "description": "description"
109             }
110           ],
111           "additionalData": [
112             {
113               "key": "key",
114               "value": "value"
115             }
116           ],
117           "sourcePosition": "sourcePosition"
118         }
119       ],
120       "referenceDocs": [
121         {
122           "url": "url",
123           "description": "description"
124         }
125       ],
126       "referenceId": "referenceId",
127       "relatedParties": [
128         {
129           "name": "name",
130           "relationship": "relationship"
131         }
132       ],
133       "reportUrl": "reportUrl",
134       "sanctionData": [
135         {
136           "countryCode": "countryCode",
137           "countryName": "countryName",
138           "sourceName": "sourceName",
139           "sourceUrl": "sourceUrl",
140           "sourceReason": "sourceReason",
141           "listingStart": "listingStart",
142           "listingEnd": "listingEnd",
143           "imageUrl": "imageUrl",
144           "referenceDocs": [
145             {
146               "url": "url",
147               "description": "description"
148             }
149           ],
150           "additionalData": [
151             {
152               "key": "key",
153               "value": "value"
154             }
155           ]
156         }
157       ],
158       "searchId": "searchId",
159       "serviceProvider": "serviceProvider",
160       "watchlistData": [
161         {
162           "countryCode": "countryCode",
163           "countryName": "countryName",
164           "sourceName": "sourceName",
165           "sourceUrl": "sourceUrl",
166           "sourceReason": "sourceReason",
167           "listingStart": "listingStart",
168           "listingEnd": "listingEnd",
169           "imageUrl": "imageUrl",
170           "referenceDocs": [
171             {
172               "url": "url",
173               "description": "description"
174             }
175           ],
176           "additionalData": [
177             {
178               "key": "key",
179               "value": "value"
180             }
181           ]
182         }
183       ]
184     },
185     "errors": [
186       {
187         "code": "code",
188         "description": "description",
189         "location": "location"
190       }
191     ],
192     "notes": {
193       "key": {
194         "type": "type",
195         "value": "value"
196       }
197     },
198     "systemStatus": "VALID",
199     "manualStatus": "TRUE_POSITIVE",
200     "state": "IN_PROGRESS",
201     "riskFactors": [
202       {
203         "factor": "factor",
204         "value": "value"
205       }
206     ],
207     "updatedBy": "updatedBy"
208   }
209 }

At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check. If this call is successful, an entity is populated with with any details supplied if it doesn't not already have a name.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

Request

This endpoint expects an object.

providerReferenceIdstringOptional

provider reference Id if known. May be referred to as checkId or interviewId in vendor specific document

tokenstringOptional

if no check id has yet been created for this idv check, pass through the token instead

commentobjectOptional

Response

statusenum or null

Status of the process. Status can be one of:

IN_PROGRESS - the provider has been sent the request and is currently still processing the result
CHECK_PROCESSING_DOWNLOAD_FAIL - the provider has been sent the request and is currently still processing the result, there was an issue downloading the images that will be retried later automatically
WAITING_SELFIE_UPLOAD - the selfie has not been uploaded yet by the applicant, still awaiting applicant action
CHECK_PROCESSING - the provider has been sent the request and is currently still processing the result
DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT - the document is too large to be processed
DOCUMENT_INVALID_INCORRECT_FILE_FORMAT - the document is not a supported file format, mostly only jpeg and png are supported but this is provider specific
PROVIDER_OFFLINE - the provider is not available for processing the request
COMPLETE - process is valid and completed

requestIdstring or null

The unique request ID for the API call made.

workflowExecutionIdstring or null

If a workflow was run as part of the processing, this is the workflow execution id

ocrResultobject or null

Path parameters

Headers

Request

Response

Errors