Creates a KYC document.
Creates a KYC document.
Kyc document resource.
{ "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "notes": "string", "reason": "string", "matchLevel": 2, "settings": { "weights": { "containsImage": 100, "isIdentityDocument": 100, "isPublishedOnline": 100, "firstName": 100, "lastName": 100, "expirationDate": 100, "dateOfBirth": 100, "matchesDateOfBirth": 100, "issueDate": 100, "hasMinimalAge": 100, "hasMatchingFaceProof": 100, "nationality": 100, "documentSubtype": 100, "isTampered": 100 }, "thresholds": { "rejectBelow": 100, "acceptAbove": 100 } } }
201
KYC document created.
401
Unauthorized access. Invalid credentials used.
403
Access forbidden.
422
Invalid data sent.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "requestId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "processedTime": "2019-08-24T14:15:22Z", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "reviewerId": "44433322-2c4y-483z-a0a9-158621f77a21", "reviewerName": "string", "reviewStartTime": "2019-08-24T14:15:22Z", "reviewTime": "2019-08-24T14:15:22Z", "notes": "string", "tags": [ { "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21", "name": "New", "type": "customer", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { "href": "string", "rel": "self" } ] } ], "reason": "string", "matchLevel": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { "containsImage": true, "isIdentityDocument": true, "isPublishedOnline": false, "matchingImages": [ "string" ], "firstName": "John", "lastName": "Doe", "dateOfBirth": "2019-08-24T14:15:22Z", "expirationDate": "2019-08-24T14:15:22Z", "issueDate": "2019-08-24T14:15:22Z", "hasMinimalAge": true, "nationality": "US", "issuanceCountry": "CA", "issuanceRegion": "Ontario", "documentNumber": "1234567890", "documentSubtype": "passport", "hasMatchingFaceProof": false, "isTampered": false, "expiryDate": "2019-08-24T14:15:22Z" } }, "parsedData": { "score": 0.75, "data": { "containsImage": true, "isIdentityDocument": true, "isPublishedOnline": false, "matchingImages": [ "string" ], "firstName": "John", "lastName": "Doe", "dateOfBirth": "2019-08-24T14:15:22Z", "expirationDate": "2019-08-24T14:15:22Z", "issueDate": "2019-08-24T14:15:22Z", "hasMinimalAge": true, "nationality": "US", "issuanceCountry": "CA", "issuanceRegion": "Ontario", "documentNumber": "1234567890", "documentSubtype": "passport", "hasMatchingFaceProof": false, "isTampered": false, "expiryDate": "2019-08-24T14:15:22Z" } }, "settings": { "weights": { "containsImage": 100, "isIdentityDocument": 100, "isPublishedOnline": 100, "firstName": 100, "lastName": 100, "expirationDate": 100, "dateOfBirth": 100, "matchesDateOfBirth": 100, "issueDate": 100, "hasMinimalAge": 100, "hasMatchingFaceProof": 100, "nationality": 100, "documentSubtype": 100, "isTampered": 100 }, "thresholds": { "rejectBelow": 100, "acceptAbove": 100 } }, "_links": [ { "href": "string", "rel": "self" } ], "_embedded": { "customer": { }, "files": [ ] } }