Enroll - Create Document Validation
Endpoint:
POST - https://api.verifik.co/v2/document-validations/app-registration
Headers
Include the necessary authentication headers, as well as any other headers required for authorization and content-type, such as:
| Name | Value |
|---|---|
Content-Type |
|
Authorization |
|
Body
image - String - required the base64 image of the document that will be scanned and analyzed.
backImage - String - optional the base64 image of the back side of the document that will be scanned and analyzed.
force - Boolean - optional this value is set if you require to do the backImage and you want to update the existing documentValidation so it has both sides.
Request
curl --location 'https://api.verifik.co/v2/document-validations/app-registration' \
--header 'Authorization: JWT eyJhbGciOiJIUzIkpXVCJ9.eyJhcHB...0NH0.AcdD_-BGPUoj2bFRc-N6uJGm-PEpv6I' \
--header 'Content-Type: application/json' \
--data '{
"image": "<base_64_image>"
}'
const axios = require('axios');
let data = JSON.stringify({
"image": "<your_base_64_image>"
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.verifik.co/v2/document-validations/app-registration',
headers: {
'Authorization': 'JWT eyJhbGciOiJIUzkpXVCJ9.eyJhcHBSZWNz2NTc0NH0.AcdD_-BGPUoj2bFRE8oUkuKZIii3c-N6uJGm-PEpv6I',
'Content-Type': 'application/json'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
let parameters = "{\n \"image\": \"your_base_64_image_here\"}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "https://api.verifik.co/v2/document-validations/app-registration")!,timeoutInterval: Double.infinity)
request.addValue("JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBSZWdpNH0.AcdD_-BGPUoj2bFRE8oUkuKZIii3c-N6uJGm-PEpv6I", forHTTPHeaderField: "Authorization")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
val client = OkHttpClient()
val mediaType = "application/json".toMediaType()
val body = "{\n \"image\": \"your_base_64_image_here\"\n}".toRequestBody(mediaType)
val request = Request.Builder()
.url("https://api.verifik.co/v2/document-validations/app-registration")
.post(body)
.addHeader("Authorization", "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBSZWdpc0NH0.AcdD_-BGPUoj2bFRE8oUkuKZIii3c-N6uJGm-PEpv6I")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute()Response
{
"data": {
"documentValidation": {
"_id": "6720ff1880ba4745a18494ba",
"documentNumber": "1.058.843.805",
"documentType": "CC",
"project": "671ea085c963a3247fda57c4",
"projectFlow": "671ea0b3c963a3247fda57cb",
"url": "https://cdn.verifik.co/ocr/671a7f594e3bb7129d1d89af/1730215695675-image.jpeg",
"status": "ACTIVE_BUT_UNVERIFIED",
"imageValidated": false,
"validationMethod": "SCAN_PROMPT",
"inputMethod": "NOT_SET",
"namesMatch": false,
"fullNameMatchPercentage": 0,
"firstNameMatchPercentage": 0,
"lastNameMatchPercentage": 0,
"OCRExtraction": {
"dateOfBirth": "27-DIC-1988",
"placeOfBirth": "PENSILVANIA (CALDAS)",
"height": "1.62",
"bloodType": "O+",
"gender": "Female",
"age": "Unknown",
"expeditionDate": "04-ENE-2007",
"expeditionPlace": "PENSILVANIA",
"barcodeNumber": "A-1500150-00669032-F-1058843805-20150217",
"country": "Colombia",
"documentType": "CC",
"firstName": "LINA MARCELA",
"lastName": "YEPES SALAZAR",
"fullName": "LINA MARCELA YEPES SALAZAR",
"documentNumber": "1.058.843.805"
},
"scoreValidated": false,
"type": "signup",
"appRegistration": "67203bdfb541ca63ff7241f3",
"client": "671a7f594e3bb7129d1d89af",
"updatedAt": "2024-10-29T15:28:45.285Z",
"createdAt": "2024-10-29T15:28:24.313Z",
"__v": 0
},
"appRegistration": {
"_id": "67203bdfb541ca63ff7241f3",
"client": "671a7f594e3bb7129d1d89af",
"project": {
"dataProtection": {
"name": "",
"email": null,
"address": null,
"address2": null,
"city": null,
"postalCode": null,
"country": null
},
"branding": {
"bgColor": "#FFFBEF",
"buttonColor": "#A900F8",
"buttonTxtColor": "#F7E7FF",
"txtColor": "#004D24",
"titleColor": "#14AE5C",
"logo": "https://cdn.verifik.co/projects/mandatoryKYC_1730077735358-image.jpeg",
"rightImage": null,
"rightBackgroundColor": "#FFFBEF",
"borderColor": "#B2BDD3",
"rightImagePosition": "center center"
},
"_id": "671ea085c963a3247fda57c4",
"client": "671a7f594e3bb7129d1d89af",
"name": "mandatory KYC",
"projectMembers": [],
"status": "active",
"currentStep": 1,
"lastStep": 1,
"allowedCountries": [
"Colombia",
"Mexico"
],
"updatedAt": "2024-10-28T20:46:52.277Z",
"createdAt": "2024-10-27T20:20:21.984Z",
"__v": 0,
"assignedCollection": "671ea086c963a3247fda57c6",
"collectionCode": "4abe0c6c-19c9-453e-8ae2-23914ec703f5"
},
"projectFlow": {
"_id": "671ea0b3c963a3247fda57cb",
"client": "671a7f594e3bb7129d1d89af",
"project": "671ea085c963a3247fda57c4",
"type": "onboarding",
"status": "active",
"version": 1,
"redirectUrl": "https://debug.verifik.co",
"loginSettings": null,
"linkSettings": null,
"onboardingSettings": {
"steps": {
"signUpForm": "mandatory",
"basicInformation": "skip",
"document": "mandatory",
"liveness": "mandatory",
"form": "skip"
},
"signUpForm": {
"fullName": true,
"email": true,
"emailGateway": "mailgun",
"phone": true,
"phoneGateway": "both",
"extraFields": [],
"showTermsAndConditions": true,
"showPrivacyNotice": true
},
"basicInformation": {
"age": false,
"dateOfBirth": false,
"gender": false,
"address": false,
"postalCode": false
},
"document": {
"useGovernmentID": true,
"usePassport": true,
"useLicense": true,
"verifyNames": true,
"verifyCriminalHistory": true,
"uploadDocumentAllowed": true,
"scanDocumentAllowed": true,
"validationMethod": "SCAN_PROMPT",
"fallbackValidationMethod": "SCAN_ZERO",
"compareMinScore": 0.67,
"maxAttempts": 3
},
"liveness": {
"livenessMinScore": 0.7,
"searchMode": "FAST",
"searchMinScore": 0.85,
"maxAttempts": 3
}
},
"security": {
"strategy": "blacklist",
"source": "API",
"apiUrl": "https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/demo-passwordless-validation-url",
"apiTestType": "email",
"apiTestValue": "miguel@verifik.co",
"_id": "671ea0b3c963a3247fda57cc"
},
"systemForm": "671ea0b3c963a3247fda57cd",
"updatedAt": "2024-10-28T01:08:46.163Z",
"createdAt": "2024-10-27T20:21:07.648Z",
"__v": 4,
"allowedCountries": []
},
"status": "ONGOING",
"email": "juan_928188@verifik.co",
"countryCode": "+57",
"phone": "0452579469",
"currentStep": "instructions",
"redFlags": 0,
"language": "en",
"failedEmailValidations": [],
"failedPhoneValidations": [],
"failedBiometricValidations": [],
"failedDocumentValidations": [],
"informationValidation": {
"_id": "67203bdfb541ca63ff7241f4",
"client": "671a7f594e3bb7129d1d89af",
"project": "671ea085c963a3247fda57c4",
"projectFlow": "671ea0b3c963a3247fda57cb",
"appRegistration": "67203bdfb541ca63ff7241f3",
"status": "FAILED",
"validationMethod": "MANUAL",
"fullName": "Juan Fernández",
"firstName": "",
"lastName": "",
"namesMatch": false,
"fullNameMatchPercentage": 0,
"firstNameMatchPercentage": 0,
"lastNameMatchPercentage": 0,
"gender": "NA",
"type": "signup",
"notes": "",
"updatedAt": "2024-10-29T01:37:10.180Z",
"createdAt": "2024-10-29T01:35:27.255Z",
"__v": 0,
"criminalData": {
"world_api_interpol": {
"cards": [
{
"arrestWarrants": [
{
"issuingCountryId": "SV",
"charge": "TRÁFICO ILEGAL DE PERSONAS"
}
],
"weight": "68",
"languagesSpokenIds": [
"SPA"
],
"height": "1.7",
"sexId": "M",
"countryOfBirthId": "SV",
"distinguishingMarks": null,
"eyesColorsId": [
"BROD"
],
"hairsId": [
"BLA"
],
"placeOfBirth": "SAN MIGUEL"
}
],
"person": {
"firstName": "JUAN",
"lastName": "FERNÁNDEZ",
"fullName": "JUAN FERNÁNDEZ"
},
"totalCards": 1
},
"world_api_dea": {
"foundInDEA": false
},
"world_api_europol": {
"foundInEuropol": false
},
"requestedAt": "2024-10-29 01:37:10",
"foundKeys": [
"world_api_interpol"
]
}
},
"name": "Juan Fernández",
"accessControlLog": "67203bdfb541ca63ff7241f7",
"updatedAt": "2024-10-29T15:28:45.658Z",
"createdAt": "2024-10-29T01:35:27.562Z",
"__v": 0,
"emailValidation": "67203be1b541ca63ff724209",
"phoneValidation": "67203beab541ca63ff724220",
"documentValidation": "6720ff1880ba4745a18494ba"
}
}
}Last updated