Approve Manual KYC for an individual

POST

Approve manual KYC (mKYC) for an individual as to allow them to pass all KYC workflow steps without performing eKYC. To ensure there is enough evidence for the mKYC process to be valid, the individual will need to have documents that match at least one of the following combinations:

1 Primary Photographic ID e.g.

”DRIVERS_LICENSE”: Driver’s license.
”PASSPORT”: Passport

2 Primary Non-Photographic IDs e.g.

”BIRTH_CERT”: Birth certificate
”CITIZENSHIP”: Citizenship certificate

1 Primary Non-Photographic ID AND 1 Secondary ID e.g.

”VISA”: Visa document (not Visa payment card)
“IMMIGRATION”: Immigration card
”NATIONAL_HEALTH_ID”: Any national health program ID card (e.g. Medicare, NHS)
“NAME_CHANGE”: Name change confirmation
”MARRIAGE_CERT”: Marriage certificate

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional

Username provided by API caller

Request

This endpoint expects an object.

approvedBystringRequired

Who approved the mKYC verification process.

approvedDocumentslist of stringsRequired

The identity documents approved as part of the mKYC verification process.

commentobjectOptional

Response

requestIdstringOptional

The unique request ID for the API call made.

processResultslist of objectsOptional

POST

1 curl -X POST https://api.uat.frankie.one/v2/individuals/entityId/results/mkyc \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4      -H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5      -H "api_key: <apiKey>" \
6      -H "Content-Type: application/json" \
7      -d '{
8   "approvedBy": "approvedBy",
9   "approvedDocuments": [
10     "approvedDocuments"
11   ]
12 }'

200Successful

1 {
2   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3   "processResults": [
4     {
5       "processResultId": "processResultId",
6       "schemaVersion": 1,
7       "entityId": "entityId",
8       "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
9       "stepName": "stepName",
10       "stepType": "stepType",
11       "objectType": "objectType",
12       "objectId": "objectId",
13       "createdAt": "2024-01-15T09:30:00Z",
14       "updatedAt": "2024-01-15T09:30:00Z",
15       "groupId": "groupId",
16       "providerResult": {
17         "name": "name",
18         "source": "source",
19         "sourceNormalized": "sourceNormalized",
20         "reference": "reference",
21         "fuzziness": {
22           "normalized": 1.1,
23           "actual": "actual"
24         },
25         "confidence": {
26           "normalized": 1.1,
27           "actual": "actual"
28         },
29         "riskScore": 1.1,
30         "errorCode": "errorCode",
31         "errorMessage": "errorMessage"
32       },
33       "result": "MATCH",
34       "class": "KYC",
35       "supplementaryData": {
36         "type": "MATCHLIST",
37         "attributes": [
38           {
39             "attribute": {
40               "type": "ENTITY_TYPE",
41               "value": "value"
42             },
43             "confidence": 1.1
44           }
45         ],
46         "confidence": 1.1,
47         "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
48         "entityType": "INDIVIDUAL",
49         "entryId": "supplementaryData",
50         "matchlistId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
51         "notes": {
52           "key": {
53             "type": "type",
54             "value": "value"
55           }
56         },
57         "reasons": [
58           "SYNTHETIC_ID"
59         ],
60         "reference": "CERT-BAD-ACTOR-1234-5678"
61       },
62       "errors": [
63         {
64           "code": "code",
65           "description": "description",
66           "location": "location"
67         }
68       ],
69       "notes": {
70         "key": {
71           "type": "type",
72           "value": "value"
73         }
74       },
75       "systemStatus": "VALID",
76       "manualStatus": "TRUE_POSITIVE",
77       "state": "IN_PROGRESS",
78       "riskFactors": [
79         {
80           "factor": "factor",
81           "value": "value"
82         }
83       ],
84       "updatedBy": "updatedBy"
85     }
86   ]
87 }

Invalidate any Manual KYC evidences of an individual

Up Next

Built with

1	curl -X POST https://api.uat.frankie.one/v2/individuals/entityId/results/mkyc \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5	-H "api_key: <apiKey>" \
6	-H "Content-Type: application/json" \
7	-d '{
8	"approvedBy": "approvedBy",
9	"approvedDocuments": [
10	"approvedDocuments"
11	]
12	}'

1	{
2	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3	"processResults": [
4	{
5	"processResultId": "processResultId",
6	"schemaVersion": 1,
7	"entityId": "entityId",
8	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
9	"stepName": "stepName",
10	"stepType": "stepType",
11	"objectType": "objectType",
12	"objectId": "objectId",
13	"createdAt": "2024-01-15T09:30:00Z",
14	"updatedAt": "2024-01-15T09:30:00Z",
15	"groupId": "groupId",
16	"providerResult": {
17	"name": "name",
18	"source": "source",
19	"sourceNormalized": "sourceNormalized",
20	"reference": "reference",
21	"fuzziness": {
22	"normalized": 1.1,
23	"actual": "actual"
24	},
25	"confidence": {
26	"normalized": 1.1,
27	"actual": "actual"
28	},
29	"riskScore": 1.1,
30	"errorCode": "errorCode",
31	"errorMessage": "errorMessage"
32	},
33	"result": "MATCH",
34	"class": "KYC",
35	"supplementaryData": {
36	"type": "MATCHLIST",
37	"attributes": [
38	{
39	"attribute": {
40	"type": "ENTITY_TYPE",
41	"value": "value"
42	},
43	"confidence": 1.1
44	}
45	],
46	"confidence": 1.1,
47	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
48	"entityType": "INDIVIDUAL",
49	"entryId": "supplementaryData",
50	"matchlistId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
51	"notes": {
52	"key": {
53	"type": "type",
54	"value": "value"
55	}
56	},
57	"reasons": [
58	"SYNTHETIC_ID"
59	],
60	"reference": "CERT-BAD-ACTOR-1234-5678"
61	},
62	"errors": [
63	{
64	"code": "code",
65	"description": "description",
66	"location": "location"
67	}
68	],
69	"notes": {
70	"key": {
71	"type": "type",
72	"value": "value"
73	}
74	},
75	"systemStatus": "VALID",
76	"manualStatus": "TRUE_POSITIVE",
77	"state": "IN_PROGRESS",
78	"riskFactors": [
79	{
80	"factor": "factor",
81	"value": "value"
82	}
83	],
84	"updatedBy": "updatedBy"
85	}
86	]
87	}