Endusers are individuals and/or companies that are end consumers of the products/services of Blackthorn API.
Currently we support only individual type of accounts.
Create enduser
-
POST /customer/endusers Create enduser, by passing required information, including KYC
-
Parameters: No parameters
-
Request body:
- Example Value
- Schema
{ "enduser_meta": {}, "email": "string", "person": { "address": { "address_city": "string", "address_iso_country": "string", "address_number": "string", "address_postal_code": "string", "address_refinement": "string", "address_region": "string", "address_street": "string" }, "address_history": { "address_city": "string", "address_end_date": "2022-02-07T16:18:20.457Z", "address_start_date": "2022-02-07T16:18:20.457Z", "address_iso_country": "string", "address_number": "string", "address_postal_code": "string", "address_refinement": "string", "address_region": "string", "address_street": "string" }, "name": "string", "citizenship": "string", "country_of_residence": "string", "country_of_birth": "string", "date_of_birth": "2022-02-07T16:18:20.457Z", "date_onboarded": "2022-02-07T16:18:20.457Z", "document_expiration_date": "2022-02-07T16:18:20.457Z", "document_issuer": "string", "document_number": "string", "document_type": "passport", "email": "user@example.com", "nationality": "string", "pep": "string", "pep_notes": "string", "pep_type": "direct", "social_security_number": "string", "telephone": "string", "tin": "string", "tin_type": "string" }, "kyc": { "provider": "sumsub", "applicantId": "12345", } }Responses:200- Example Value
- Controls
- Accept
- Header
{ "enduser_id": "string" }400- Example Value
- Controls
- Accept
- Header
Bad request
-
GET /customer/endusers/{enduser_id} Fetch enduser entity
-
Parameters:Name Description
-
Responses:200
- Example Value
- Controls
- Accept
- Header
{ "endusers": [ { "enduser_meta": {}, "email": "string", "person": { "address": { "address_city": "string", "address_iso_country": "string", "address_number": "string", "address_postal_code": "string", "address_refinement": "string", "address_region": "string", "address_street": "string" }, "address_history": { "address_city": "string", "address_end_date": "2022-02-07T17:07:43.225Z", "address_start_date": "2022-02-07T17:07:43.225Z", "address_iso_country": "string", "address_number": "string", "address_postal_code": "string", "address_refinement": "string", "address_region": "string", "address_street": "string" }, "name": "string", "citizenship": "string", "country_of_residence": "string", "country_of_birth": "string", "date_of_birth": "2022-02-07T17:07:43.225Z", "date_onboarded": "2022-02-07T17:07:43.225Z", "document_expiration_date": "2022-02-07T17:07:43.225Z", "document_issuer": "string", "document_number": "string", "document_type": "passport", "email": "user@example.com", "nationality": "string", "pep": "string", "pep_notes": "string", "pep_type": "direct", "social_security_number": "string", "telephone": "string", "tin": "string", "tin_type": "string" }, "kyc": { "provider": "sumsub", "reviewStatus": "completed", "kycHistory": [ { "applicantId": "string", "inspectionId": "string", "applicantType": "individual", "correlationId": "string", "externalUserId": "string", "type": "applicantReviewed, applicantPending", "reviewResult": { "reviewAnswer": "RED", "reviewRejectType": "string", "rejectLabels": [ "UNSATISFACTORY_PHOTOS, DOCUMENT_PAGE_MISSING" ] }, "reviewStatus": "string", "createdAt": "string", "sourceKey": "string", "clientId": "string" } ], "proofOfResidenceResult": { "stepStatuses": "string", "country": "string", "idDocType": "string", "reviewResult": { "reviewAnswer": "string" }, "forbidden": true, "doubleSided": "string", "imageReviewResults": { "256841956": { "reviewAnswer": "string" }, "367104517": { "reviewAnswer": "string" } }, "imageIds": [ 0 ] }, "identityResult": { "stepStatuses": "string", "country": "string", "idDocType": "string", "reviewResult": { "reviewAnswer": "string" }, "forbidden": true, "doubleSided": "string", "imageReviewResults": { "256841956": { "reviewAnswer": "string" }, "367104517": { "reviewAnswer": "string" } }, "imageIds": [ 0 ] }, "selfieResult": { "stepStatuses": "string", "country": "string", "idDocType": "string", "reviewResult": { "reviewAnswer": "string" }, "forbidden": true, "doubleSided": "string", "imageReviewResults": { "256841956": { "reviewAnswer": "string" }, "367104517": { "reviewAnswer": "string" } }, "imageIds": [ 0 ] }, "rejectLabels": [ "string" ], "sumsubLastReview": { "applicantId": "string", "inspectionId": "string", "applicantType": "individual", "correlationId": "string", "externalUserId": "string", "type": "applicantReviewed, applicantPending", "reviewResult": { "reviewAnswer": "RED", "reviewRejectType": "string", "rejectLabels": [ "UNSATISFACTORY_PHOTOS, DOCUMENT_PAGE_MISSING" ] }, "reviewStatus": "string", "createdAt": "string", "sourceKey": "string", "clientId": "string" }, "kycId": { "country": "string", "dateOfBirth": 0, "firstName": "string", "idDocumentScore": 0, "idDocumentType": "string", "lastName": "string", "nationality": "string", "validUntil": {}, "issuedDate": {}, "documentNumber": "KC4564", "passedPOI": true }, "kycAddress": { "addressCity": "string", "addressDocumentScore": 0, "addressDocumentType": "string", "addressISOCountry": "string", "addressNumber": "string", "addressPostalCode": "string", "addressRefinement": "string", "addressState": "string", "addressStreet": "string", "validUntil": {}, "issuedDate": {}, "dob": {}, "passedPOA": true } } } ] }400- Example Value
- Controls
- Accept
- Header
Bad request
401- Example Value
- Controls
- Accept
- Header
Unauthorized
-
-
PUT /customer/endusers/{enduser_id} By updating enduser, you notify Blackthorn about enduser information updates. Keep enduser always updated, for monitoring purposes.
-
Parameters:Name Description
-
Request body:
- Example Value
- Schema
{ "email": "string", "person": { "address": { "address_city": "string", "address_iso_country": "string", "address_number": "string", "address_postal_code": "string", "address_refinement": "string", "address_region": "string", "address_street": "string" }, "address_history": { "address_city": "string", "address_end_date": "2022-02-07T17:15:28.133Z", "address_start_date": "2022-02-07T17:15:28.133Z", "address_iso_country": "string", "address_number": "string", "address_postal_code": "string", "address_refinement": "string", "address_region": "string", "address_street": "string" }, "name": "string", "citizenship": "string", "country_of_residence": "string", "country_of_birth": "string", "date_of_birth": "2022-02-07T17:15:28.133Z", "date_onboarded": "2022-02-07T17:15:28.133Z", "document_expiration_date": "2022-02-07T17:15:28.133Z", "document_issuer": "string", "document_number": "string", "document_type": "passport", "email": "user@example.com", "nationality": "string", "pep": "string", "pep_notes": "string", "pep_type": "direct", "social_security_number": "string", "telephone": "string", "tin": "string", "tin_type": "string" } }Responses:200- Example Value
- Controls
- Accept
- Header
{ "status": "string", "enduser_id": "string" }400401
-
Get Enduser
Update Enduser
-