KYC document webhook request body resource.
KYC document webhook request body resource.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N", "eventType": "kyc-document-accepted", "_embedded": { "customer": { "id": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "email": "user@example.com", "firstName": "string", "lastName": "string", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "defaultPaymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "customFields": { "foo": "bar" }, "primaryAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ { "label": "main", "value": "512-710-1640", "primary": true } ], "emails": [ { "label": "main", "value": "rebilly@example.com", "primary": true } ], "dob": "1980-04-01", "jobTitle": "CEO", "hash": "056ae6d97c788b9e98b049ebafd7b229bf852221" }, "company": { "name": "string", "domain": "string", "yearFounded": 0, "industry": "string", "employeesCount": 0, "country": "string", "locality": "string", "_links": [ { "href": "string", "rel": "linkedin" } ] }, "averageValue": { "currency": "USD", "amount": 0.1, "amountUsd": 0.1 }, "paymentCount": 0, "lastPaymentTime": "2019-08-24T14:15:22Z", "lifetimeRevenue": { "currency": "USD", "amount": 0.1, "amountUsd": 0.1 }, "invoiceCount": 0, "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" } ] } ], "revision": 0, "isEddRequired": false, "hasFulfilledKyc": true, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "taxNumbers": [ { "type": "eu-vat", "value": "GB980780684", "isDefault": true, "isValid": true } ], "_links": [ { "href": "string", "rel": "self" } ], "_embedded": { "leadSource": { } } }, "kycDocument": { "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": [ ] } } }, "_links": [ { "href": "string", "rel": "customer" } ] }
2xx
Returns any 2xx status to indicate that data is received.