--- updatedAt: 2026-05-29T18:12:06.000Z agentTools: projectIndex: https://docs.vouched.id/llms.txt --- # Submit Job Submit a verification job. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "version": "0.13.13", "title": "Vouched API", "description": "Official Vouched REST API.\n\n## Environments\n\nThe `servers` list below has two production hosts: `verify.vouched.id` (US) and\n`verify.eu.vouched.id` (EU). A separate **sandbox** deployment runs the same service with\n`SANDBOX_MODE` enabled, where only the identity-verification job endpoints are mounted —\n`GET`/`POST /api/jobs`, `GET`/`DELETE /api/jobs/{id}`, `GET /api/jobs/{id}/download` and\n`POST /api/jobs/session`. Every other endpoint **under `/api`** in this document returns **404**\nin sandbox, including AML, SSN, TIN, DOB, invites and CrossCheck.\n\nThe provider webhook receivers are the exception: `/api/tin/webhook`,\n`/api/dlv/webhook/license-validation`, `/v1/sendgrid/email/send` and `/v1/twilio/sms/send` are\nregistered outside the sandbox gate and remain available.\n", "x-logo": { "url": "https://i.pinimg.com/originals/88/29/2f/88292f8ffd6231d0c41634f2e707c34a.png", "altText": "Vouched logo" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "servers": [ { "url": "https://verify.vouched.id", "description": "US (default)" }, { "url": "https://verify.eu.vouched.id", "description": "EU" } ], "tags": [ { "name": "jobs", "description": "This is the section where you will do actions for all things related to running, completing, and getting the results of Jobs." } ], "paths": { "/api/jobs": { "post": { "description": "Submit a verification job.", "summary": "Submit Job", "operationId": "SubmitJob", "security": [ { "X-API-Key": [] } ], "tags": [ "jobs" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/body_4" }, "examples": { "0": { "value": { "type": "id-verification", "callbackURL": "https://yourwebsite.com", "properties": [ { "name": "propertiesName", "value": "propertiesValue" } ], "params": { "userPhoto": "string", "idPhoto": "string", "enableCrossCheck": false, "enableDarkWeb": false, "enableDriversLicenseValidation": false, "enableIPAddress": false, "enablePhysicalAddress": false } } } } } } }, "responses": { "201": { "description": "Running a Job through Vouched.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_1" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" }, "500": { "$ref": "#/components/responses/500" } } } } }, "components": { "securitySchemes": { "X-API-Key": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "The authentication private key" } }, "schemas": { "job_review": { "type": "object", "description": "Reviewer overrides applied to the job. Every field defaults to `null`, meaning no override was recorded. A boolean override of `false` participates in the `reviewSuccess` calculation as a rejection; `true` and `null` do not. The original Vouched decision (`result.success`) is always preserved.\n\n`issueDate` is accepted and persisted by `PUT /api/jobs/{id}/review` but is not echoed back in this object.", "properties": { "idValid": { "type": [ "boolean", "null" ], "description": "Reviewer override for whether the id is valid." }, "selfieValid": { "type": [ "boolean", "null" ], "description": "Reviewer override for whether the selfie is valid." }, "faceMatch": { "type": [ "boolean", "null" ], "description": "Reviewer override for whether the faces match." }, "nameMatch": { "type": [ "boolean", "null" ], "description": "Reviewer override for whether the names match." }, "birthDateMatch": { "type": [ "boolean", "null" ], "description": "Reviewer override for whether the birth dates match." }, "firstName": { "type": [ "string", "null" ], "description": "Reviewer corrected first name." }, "lastName": { "type": [ "string", "null" ], "description": "Reviewer corrected last name." }, "docId": { "type": [ "string", "null" ], "description": "Reviewer corrected document id number." }, "idType": { "type": [ "string", "null" ], "description": "Reviewer corrected id type. See `document_type` for the accepted values." }, "birthDate": { "type": [ "string", "null" ], "description": "Reviewer corrected date of birth." }, "expireDate": { "type": [ "string", "null" ], "description": "Reviewer corrected expiration date." }, "state": { "type": [ "string", "null" ], "description": "Reviewer corrected state/province/territory [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2)." }, "country": { "type": [ "string", "null" ], "description": "Reviewer corrected country [ISO 3166-1 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "dlvValid": { "type": [ "boolean", "null" ], "description": "Reviewer override for the DLV check." }, "barcodeMatch": { "type": [ "boolean", "null" ], "description": "Reviewer override for the barcode reconciliation check." } } }, "request_info": { "type": "object", "properties": { "ipaddress": { "description": "The user's IP address.", "type": "string" }, "useragent": { "description": "The user's browser agent.", "type": "string" }, "referer": { "description": "The refering browser location.", "type": "string" } } }, "job_parameters": { "type": "object", "properties": { "id": { "description": "The job ID the parameters belong to.", "type": "string" }, "idPhoto": { "description": "The user's official identification photo in base64.", "type": "string" }, "idPhotoUrl": { "description": "The user's id photo as a timed (15 min) signed url.", "type": "string" }, "idPhotoDetect": { "description": "A cropped aligned version of the id photo in base64.", "type": "string" }, "idPhotoDetectUrl": { "description": "A cropped aligned version of the id photo as timed (15 min) signed url.", "type": "string" }, "idPhotoDetectDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "idPhotoDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "idDistancePhoto": { "description": "A wider-framed capture of the id in base64.", "type": "string" }, "idDistancePhotoUrl": { "description": "A wider-framed capture of the id as a timed (15 min) signed url.", "type": "string" }, "idDistanceDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "backIdPhoto": { "description": "The back of the user's official identification photo in base64.", "type": "string" }, "backIdPhotoUrl": { "description": "The back of the user's id photo as a timed (15 min) signed url.", "type": "string" }, "backIdPhotoDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "digitalPortraitPhoto": { "description": "The portrait extracted from a digital id (mDL) in base64.", "type": "string" }, "digitalPortraitPhotoUrl": { "description": "The portrait extracted from a digital id (mDL) as a timed (15 min) signed url.", "type": "string" }, "userDistancePhoto": { "description": "A wider-framed capture of the user's selfie in base64.", "type": "string" }, "userDistancePhotoUrl": { "description": "A wider-framed capture of the user's selfie as a timed (15 min) signed url.", "type": "string" }, "userDistanceDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "userPhoto": { "description": "The user's selfie photo in base64.", "type": "string" }, "userPhotoUrl": { "description": "The user's selfie photo as a timed (15 min) signed url.", "type": "string" }, "userPhotoDetect": { "description": "A cropped aligned version of the selfie photo in base64.", "type": "string" }, "userPhotoDetectUrl": { "description": "A cropped aligned version of the selfie photo as timed (15 min) signed url.", "type": "string" }, "userPhotoDetectDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "userPhotoDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "source": { "description": "The source photo of a face-match (`id-reverification`) job in base64.", "type": "string" }, "sourceUrl": { "description": "The source photo of a face-match job as a timed (15 min) signed url.", "type": "string" }, "sourceDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "dest": { "description": "The destination photo of a face-match (`id-reverification`) job in base64.", "type": "string" }, "destUrl": { "description": "The destination photo of a face-match job as a timed (15 min) signed url.", "type": "string" }, "destDimensions": { "type": "object", "properties": { "width": { "description": "width of photo", "type": "integer" }, "height": { "description": "height of photo", "type": "integer" } } }, "userConfirmation": { "type": "object", "description": "Records that the user confirmed the extracted data.", "properties": { "confirmed": { "type": "boolean", "description": "The user confirmed the extracted data." } } }, "crosscheckReferenceId": { "type": "string", "description": "Reference identifier linking the job to an existing CrossCheck request." }, "email": { "type": "string", "description": "Used for crosschecking identity." }, "phone": { "type": "string", "description": "Used for crosschecking identity.", "example": "000-111-2222" }, "dob": { "type": "string", "description": "Date of birth (MM/DD/YYYY).", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$", "example": "08/23/1991" }, "firstName": { "type": "string", "description": "The user's first name." }, "lastName": { "type": "string", "description": "The user's last name." }, "address": { "type": "object", "description": "The address supplied for physical address verification.", "properties": { "unit": { "type": "string" }, "streetAddress": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state/province/territory [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2)." }, "postalCode": { "type": "string" }, "country": { "type": "string", "description": "The country [ISO 3166-1 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." } } } } }, "apijobs_properties": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the property" }, "value": { "type": "string", "description": "Value of the property" } } }, "request": { "type": "object", "properties": { "type": { "description": "Job type", "type": "string", "enum": [ "id-verification", "id-reverification", "selfie-verification", "id-crosscheck", "id-aamva", "id-aml", "ecbsv-ssn", "private-ssn", "dob", "tin-validation" ] }, "callbackURL": { "description": "Upon the job's completion, Vouched will POST the job results to the defined [webhook](https://docs.vouched.id/docs/webhooks).", "type": "string" }, "requestInfo": { "description": "User request information.", "type": "object", "$ref": "#/components/schemas/request_info" }, "parameters": { "description": "Object for 'id-verification.'", "type": "object", "$ref": "#/components/schemas/job_parameters" }, "properties": { "type": [ "array", "null" ], "description": "Arbitrary customer supplied properties sent when the job was created, echoed back so the result can be attributed in your own system. Returned for IDV jobs and for the standalone Crosscheck, AML, DOB and ITIN verifications, and on the [webhook](https://docs.vouched.id/docs/webhooks) payload. `null` when none were sent, and always `null` for SSN jobs — the SSN endpoints accept `properties` but keep them on their own stored request rather than on the job.", "items": { "$ref": "#/components/schemas/apijobs_properties" } } } }, "gender_distribution": { "type": "object", "properties": { "man": { "type": [ "number", "null" ], "description": "Frequency of the first name in men with a minimum found frequency of 0.0001. Null when the first name is unknown.", "minimum": 0 }, "woman": { "type": [ "number", "null" ], "description": "Frequency of the first name in women with a minimum found frequency of 0.0001. Null when the first name is unknown.", "minimum": 0 } } }, "gender_info": { "type": "object", "properties": { "gender": { "description": "man or woman based on extracted fields from the ID.", "type": "string", "enum": [ "man", "woman" ] }, "genderDistribution": { "description": "frequency with a range 0-100 of the first name in men and women with a mininum found frequency of 0.0001", "type": "string", "$ref": "#/components/schemas/gender_distribution" } } }, "client_data": { "type": "object", "properties": { "client": { "type": "string", "description": "Client on which the job was initialized." }, "theme": { "type": "string" }, "capture": { "type": "object", "description": "Type of image capture for each stage in the IDV process.", "properties": { "id": { "type": "string", "enum": [ "manual", "automatic" ] }, "face_match": { "type": "string", "enum": [ "manual", "automatic" ] }, "barcode": { "type": "string", "enum": [ "manual", "automatic" ] } } } } }, "document_type": { "type": "string", "description": "A recognized [id type](https://docs.vouched.id/docs/recognized-ids). For unrecognized ids the value is `other`.", "enum": [ "aetna-insurance", "cigna-insurance", "citizen", "commercial-license", "cvs-rx", "drivers-license", "drivers-license-permit", "employment", "global-entry", "handgun", "health-insurance", "identification", "indian", "indigenous", "matricula-consular", "nexus", "passport", "passport-card", "residence", "sentri", "uhc-insurance", "visa", "other" ] }, "ipFraudCheck": { "type": "object", "description": "Indicator of IP address fraud. The max attempts (default - 4) before a fraud check is triggered and the time range (default - 60 minutes) for the inspection is configurable.", "properties": { "ipFraud": { "type": "boolean", "description": "A boolean determining whether or not the ipAddress for the job was flagged as fraudulent." }, "count": { "type": "integer", "description": "Represents the number of jobs with the same IP address." }, "jobIdList": { "type": "array", "description": "List of job ids with the same IP address. Provides a maximum of 10 job IDs linked to the IP address.", "items": { "type": "string" } } } }, "address": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit number." }, "streetNumber": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The [ISO 3166-2 state/province/territory code](https://en.wikipedia.org/wiki/ISO_3166-2)." }, "postalCode": { "type": "string" }, "postalCodeSuffix": { "type": "string" }, "country": { "type": "string", "description": "The [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." } } }, "crosscheck_identity_errors": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of error encountered." }, "warnings": { "type": "boolean", "description": "Is this a warning?" }, "message": { "type": "string", "description": "Details on the occurring error." }, "suggestion": { "type": "string", "example": "John Smith", "description": "A suggestion for matching name." } } }, "crosscheck_age_range": { "type": "object", "properties": { "from": { "type": "integer", "description": "From age" }, "to": { "type": "integer", "description": "To age" } } }, "crosscheck_identity_address": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/crosscheck_identity_errors" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/crosscheck_identity_errors" } }, "isValid": { "type": "boolean", "description": "The address is a verified address." }, "isMatch": { "type": "boolean", "description": "The name on the address matches the user." }, "name": { "type": "string", "description": "The recorded name of the identity." }, "ageRange": { "description": "The age range of the name on the address.", "type": "object", "$ref": "#/components/schemas/crosscheck_age_range" }, "isForwarder": { "type": "boolean", "description": "The address is a freight forwarding address." }, "isCommercial": { "type": "boolean", "description": "The address is associated with a business." }, "type": { "type": "string", "enum": [ "incomplete-address", "po-box", "multi-unit", "single-unit", "commercial-mail-drop", "po-box-forward", "other" ] } } }, "crosscheck_identity_email": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/crosscheck_identity_errors" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/crosscheck_identity_errors" } }, "isValid": { "type": "boolean", "description": "The email is a valid email address." }, "isMatch": { "type": "boolean", "description": "The name associated with the email address matches the user." }, "name": { "type": "string", "description": "The recorded name of the identity." }, "ageRange": { "description": "The age range of the name on the email address.", "type": "object", "$ref": "#/components/schemas/crosscheck_age_range" }, "isAutoGenerated": { "type": "boolean", "description": "Indicates the email address was generated automatically." }, "isDisposable": { "type": "boolean", "description": "The email address is provided by a disposable email provider." }, "daysFirstSeen": { "type": "integer", "description": "The number of days since the email address was first seen in the data network." } } }, "crosscheck_identity_phone": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/crosscheck_identity_errors" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/crosscheck_identity_errors" } }, "isValid": { "type": "boolean", "description": "The phone number is valid." }, "isMatch": { "type": "boolean", "description": "The name associated with the phone number matches the user." }, "name": { "type": "string", "description": "The recorded name of the identity." }, "type": { "type": "string", "enum": [ "fixed-voip", "landline", "mobile", "non-fixed-voip", "premium-rate", "tollfree", "voicemail", "other" ] }, "ageRange": { "description": "The age range of the name associated with the phone number.", "type": "object", "$ref": "#/components/schemas/crosscheck_age_range" }, "carrier": { "type": "string", "description": "The phone provider." }, "isPrepaid": { "type": "boolean", "description": "The phone number is on a prepaid plan." }, "isDisposable": { "type": "boolean", "description": "The phone number is disposable." }, "isCommercial": { "type": "boolean", "description": "The phone number is associated with a business." } } }, "location": { "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" } } }, "ip_address": { "type": "object", "properties": { "city": { "type": "string", "description": "Originating City." }, "state": { "type": "string", "description": "Originating State/Province/Territory in [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2)." }, "country": { "type": "string", "description": "Originating Country in [ISO 3166-1 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "postalCode": { "type": "string", "description": "postal code." }, "location": { "type": "object", "$ref": "#/components/schemas/location" }, "isp": { "type": "string", "description": "Name of the isp." }, "organization": { "type": "string", "description": "Name of the organization associated with the IP address." }, "isAnonymous": { "type": "boolean", "description": "Is the IP address part of an anonymous network." }, "isAnonymousVpn": { "type": "boolean", "description": "Is the IP address part of an anonymous vpn network." }, "isAnonymousHosting": { "type": "boolean", "description": "Is the IP address part of an anonymous hosting network." }, "userType": { "type": "string", "description": "A description of the internet access point.", "enum": [ "business - the IP address belongs to a business ISP or a corporation.", "cafe - an internet cafe or similar location.", "cellular - the IP address is used to route traffic from devices connected to a cellular network.", "college - the IP address belongs to a college, university, or similar institute of higher education.", "content_delivery_network - belongs to a CDN (Akamai, Cloudflare, Google Cloud, etc.).", "dialup - belongs to a dial-up ISP.", "government - the IP address belongs to a government organization.", "hosting -- a commercial hosting provider.", "library - used in a library.", "military - used on a military base or similar.", "residential - the IP address belongs to a residential ISP or is otherwise primarily used by home users.", "router - a backbone or infrastructure router.", "school - primary or secondary education.", "search_engine_spider - a crawler or indexer for a search engine (Google, Bing, Yahoo, etc.).", "traveler - the IP address is used at an airport, hotel, or similar location where the users are generally traveling from their primary residence." ] } } }, "crosscheck_confidences": { "type": "object", "properties": { "identity": { "type": "number", "description": "Overall identity risk confidence. The identity score is a risk score assigned to the user based on their address, email, and phone details. These details are cross-referenced against the data provided by the user or the extracted from their ID.", "minimum": 0, "maximum": 1 }, "originalIdentity": { "type": "number", "description": "The rules-based identity score before it was replaced by the account's crosscheck model. Only returned when a model overrode `identity`.", "minimum": 0, "maximum": 1 }, "activity": { "type": [ "number", "null" ], "description": "Overall activity risk confidence that is based on dynamic attributes." } } }, "crosscheck_cip_result": { "type": "object", "description": "CIP (Customer Identification Program) outcome. Only returned when CIP scoring is enabled for the account. Does not affect the existing score, errors or other response fields.", "required": [ "version", "pass", "address" ], "properties": { "version": { "type": "integer", "description": "CIP model version." }, "pass": { "type": "boolean", "description": "CIP pass/fail. The address is matched to the applicant and valid; email and phone are excluded from the decision." }, "address": { "type": "object", "description": "The CIP element evaluated by CrossCheck.", "required": [ "match", "valid" ], "properties": { "match": { "type": "boolean", "description": "The address is matched to the applicant." }, "valid": { "type": "boolean", "description": "The address is a real, deliverable address." } } }, "email": { "type": "object", "description": "Optional. Non-CIP signal, excluded from the CIP decision. Omitted when not evaluated.", "required": [ "match", "valid" ], "properties": { "match": { "type": "boolean", "description": "The email is matched to the applicant." }, "valid": { "type": "boolean", "description": "The email is real and deliverable." } } }, "phone": { "type": "object", "description": "Optional. Non-CIP signal, excluded from the CIP decision. Omitted when not evaluated.", "required": [ "match", "valid" ], "properties": { "match": { "type": "boolean", "description": "The phone is matched to the applicant." }, "valid": { "type": "boolean", "description": "The phone is real and in service." } } } } }, "crosscheck_result": { "type": "object", "description": "CrossCheck Result", "properties": { "address": { "description": "Address match details, or null when no address was submitted or matched.", "anyOf": [ { "$ref": "#/components/schemas/crosscheck_identity_address" }, { "type": "null" } ] }, "email": { "description": "Email match details, or null when no email was submitted or matched.", "anyOf": [ { "$ref": "#/components/schemas/crosscheck_identity_email" }, { "type": "null" } ] }, "phone": { "description": "Phone match details, or null when no phone was submitted or matched.", "anyOf": [ { "$ref": "#/components/schemas/crosscheck_identity_phone" }, { "type": "null" } ] }, "gender": { "type": "object", "$ref": "#/components/schemas/gender_distribution" }, "ageRange": { "deprecated": true, "description": "Always null. The age range derived from the identity is returned on `email.ageRange`.", "anyOf": [ { "$ref": "#/components/schemas/crosscheck_age_range" }, { "type": "null" } ] }, "ip": { "description": "Validity of the submitted IP address and its distance from the submitted address. Null when no IP result is available.", "type": [ "object", "null" ], "properties": { "isValid": { "type": "boolean", "description": "Whether the IP address was resolved to a valid location." }, "distance": { "type": [ "number", "null" ], "description": "Distance between the IP address location and the submitted address. Null when it cannot be computed." } } }, "ipAddress": { "description": "IP address inspection details. Only returned for standalone crosscheck requests, and null when no IP address was submitted.", "anyOf": [ { "$ref": "#/components/schemas/ip_address" }, { "type": "null" } ] }, "model": { "type": "string", "description": "The crosscheck model used to score the identity. Only returned when the account is configured with a crosscheck model and its inference succeeded.", "enum": [ "fraud", "approval" ] }, "confidences": { "type": "object", "$ref": "#/components/schemas/crosscheck_confidences" }, "cip": { "type": "object", "$ref": "#/components/schemas/crosscheck_cip_result" } } }, "aamva": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "A boolean determining whether or not AAMVA is enabled for the account this job ran under." }, "hasErrors": { "type": "boolean", "description": "Representing if AAMVA returned any matching errors." }, "hasWarnings": { "type": "boolean", "description": "Representing if there are any warnings on the AAMVA request." }, "createdAt": { "type": [ "string", "null" ], "description": "Representing when the AAMVA request was created as a [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601)." }, "updatedAt": { "type": [ "string", "null" ], "description": "Representing the last time the AAMVA verification data was updated as a [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601)." }, "status": { "type": [ "string", "null" ], "description": "Representing the state of the AAMVA verification request. `null` when AAMVA never ran for the job.", "enum": [ "Pending", "In Progress", "Error", "Not Applicable", "Completed", null ] }, "statusMessage": { "type": "string", "description": "A message that provides additional information about the status of the verification request." }, "completedAt": { "type": [ "string", "null" ], "description": "Representing the time the verification request was completed as a [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601)." }, "confidenceScore": { "type": [ "number", "null" ], "description": "The AAMVA match confidence score. `null` when AAMVA never ran for the job." } } }, "dlv": { "type": "object", "description": "Driver's License Validation (DLV) outcome for the job. DLV is a premium feature that must be enabled on your account by Vouched.", "properties": { "dlvEnabled": { "type": "boolean", "description": "Whether DLV was enabled for this job." }, "dlvCheckPerformed": { "type": "boolean", "description": "Whether the DLV check actually ran." }, "dlvStatusMessage": { "type": [ "string", "null" ], "description": "Status of the DLV check. `null` when DLV never ran for the job.", "enum": [ "Pending", "In Progress", "Completed", "Error", "Not Applicable", "Not Performed", null ] }, "error": { "type": "string", "description": "Reason DLV could not be attempted. Absent when no precondition failed.", "enum": [ "unsupported-license-type", "unsupported-country", "missing-state", "missing-license-number", "identification-type-unsupported-by-state" ] }, "result": { "type": [ "object", "null" ], "description": "The validation result. `null` when the check did not run.", "properties": { "stateSupported": { "type": "boolean", "description": "Whether the issuing state is supported by DLV." }, "wasCheckPerformed": { "type": "boolean", "description": "Whether the upstream validation call was made." }, "checkPerformedAt": { "type": "string", "description": "The [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601) the check ran. Empty string when it did not run.", "example": "2019-09-07T15:50-04:00" }, "status": { "type": "string", "description": "The validation decision.", "enum": [ "Approved", "Not Approved" ] }, "source": { "type": "string", "description": "The authority the validation was sourced from. Empty string when unknown.", "enum": [ "governmental", "nonGovernmental", "" ] }, "fieldMatchesAvailable": { "type": "array", "description": "Fields the source was able to compare.", "items": { "type": "string" } }, "fieldMatchesSucceeded": { "type": "array", "description": "Fields that matched.", "items": { "type": "string" } }, "fieldMatchesFailed": { "type": "array", "description": "Fields that did not match.", "items": { "type": "string" } }, "fieldMatchesUnavailable": { "type": "array", "description": "Fields the source could not compare.", "items": { "type": "string" } }, "error": { "type": "string", "description": "Provider error reported for this validation attempt." }, "warning": { "type": "string", "description": "Provider warning reported for this validation attempt, for example a state restriction." } } } } }, "features_enabled": { "type": "object", "description": "Which verification features were enabled for this job, and which of them were billable. `null` means the flag was never recorded for the job.", "properties": { "idvEnabled": { "type": [ "boolean", "null" ], "description": "ID verification was enabled." }, "idvBillable": { "type": [ "boolean", "null" ], "description": "ID verification was billable." }, "faceMatchEnabled": { "type": [ "boolean", "null" ], "description": "Face match was enabled." }, "faceMatchBillable": { "type": [ "boolean", "null" ], "description": "Face match was billable." }, "aamvaEnabled": { "type": [ "boolean", "null" ], "description": "AAMVA was enabled." }, "aamvaBillable": { "type": [ "boolean", "null" ], "description": "AAMVA was billable." }, "dlvEnabled": { "type": [ "boolean", "null" ], "description": "Driver's License Validation was enabled." }, "dlvBillable": { "type": [ "boolean", "null" ], "description": "Driver's License Validation was billable." }, "amlEnabled": { "type": [ "boolean", "null" ], "description": "AML screening was enabled." }, "amlBillable": { "type": [ "boolean", "null" ], "description": "AML screening was billable." }, "crosscheckEnabled": { "type": [ "boolean", "null" ], "description": "CrossCheck was enabled." }, "crosscheckBillable": { "type": [ "boolean", "null" ], "description": "CrossCheck was billable." }, "darkwebEnabled": { "type": [ "boolean", "null" ], "description": "Dark web search was enabled." }, "darkwebBillable": { "type": [ "boolean", "null" ], "description": "Dark web search was billable." }, "physicalAddressEnabled": { "type": [ "boolean", "null" ], "description": "Physical address search was enabled." }, "physicalAddressBillable": { "type": [ "boolean", "null" ], "description": "Physical address search was billable." }, "ipAddressEnabled": { "type": [ "boolean", "null" ], "description": "IP address search was enabled." }, "ipAddressBillable": { "type": [ "boolean", "null" ], "description": "IP address search was billable." } } }, "aml_matches": { "type": "object", "description": "Details of a matched listing for an entity.", "properties": { "type": { "type": "string", "description": "The type of list matched." }, "listing_started_utc": { "type": "string", "description": "The UTC datetime the entity was added to the list." }, "listing_ended_utc": { "type": "string", "description": "The UTC datetime the entity was removed from the list." }, "name": { "type": "string", "description": "The name of the list." }, "url": { "type": "string", "description": "The public URL of the list." }, "api_name": { "type": "string", "description": "The provider's own name for the list." } } }, "aml_hits": { "type": "object", "description": "Array of hits against submitted term.", "properties": { "aka": { "type": "array", "description": "Alternative names for the entity. Note that the \"name\" field is present at the minimum.", "items": { "type": "string" } }, "politicalPositions": { "type": "array", "description": "An array of potential politcal positions associated with the individual.", "items": { "type": "string" } }, "countries": { "type": "array", "description": "Associated country names for the entity.", "items": { "type": "string" } }, "matches": { "type": "object", "description": "List of sanction, warning, and PEP lists the entity matched with.", "properties": { "sanction": { "type": "array", "description": "List of sanction lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } }, "warning": { "type": "array", "description": "List of warning lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } }, "pep": { "type": "array", "description": "List of PEP lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } }, "pepClass1": { "type": "array", "description": "List of PEP Class 1 lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } }, "pepClass2": { "type": "array", "description": "List of PEP Class 2 lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } }, "pepClass3": { "type": "array", "description": "List of PEP Class 3 lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } }, "pepClass4": { "type": "array", "description": "List of PEP Class 4 lists the entity matched with.", "items": { "type": "object", "$ref": "#/components/schemas/aml_matches" } } } } } }, "aml_result_data": { "type": "object", "description": "AML search data as it appears on an identity-verification job's `result.aml`. This is the raw ComplyAdvantage shape passed through the pipeline output filter, so `id` and `ref` are typed the opposite way round from the dedicated AML endpoints — see `aml_data.yaml`.", "properties": { "id": { "type": "integer", "description": "Numeric ComplyAdvantage search ID." }, "ref": { "type": [ "string", "null" ], "description": "Alphanumeric ComplyAdvantage search reference." }, "dob": { "type": [ "string", "null" ], "description": "DOB extracted from the ID or provided in the job request." }, "matchStatus": { "type": [ "string", "null" ], "description": "One of 'no_match', 'false_positive', 'potential_match', 'true_positive', 'unknown'.", "enum": [ "no_match", "false_positive", "potential_match", "true_positive", "unknown", null ] }, "riskLevel": { "type": [ "string", "null" ], "description": "One of 'low', 'medium', 'high', 'unknown'.", "enum": [ "low", "medium", "high", "unknown", null ] }, "submittedTerm": { "type": [ "string", "null" ], "description": "The name submitted to search against the AML lists." }, "totalHits": { "type": "integer", "description": "The number of entities that matched the submitted term." }, "updatedAt": { "type": [ "string", "null" ], "description": "The date and time the search was last updated (in UTC)." }, "totalMatches": { "type": "integer", "description": "The number of lists that matched the submitted term." }, "hits": { "$ref": "#/components/schemas/aml_hits" } } }, "aml": { "type": "object", "description": "AML screening result as it appears on an identity-verification job's `result.aml`. The mapper projects only `data` here (`src/server/rest/mappers/job-mapper.ts:608`) — `confidence`, `status` and `monitoring` are returned by the dedicated AML endpoints, not on a job result. See `aml_endpoint_result.yaml`.", "properties": { "data": { "$ref": "#/components/schemas/aml_result_data" } } }, "barcode_data": { "type": "object", "description": "Identity data decoded from the barcode on the back of the ID.", "properties": { "firstName": { "type": [ "string", "null" ], "description": "First name from the barcode." }, "lastName": { "type": [ "string", "null" ], "description": "Last name from the barcode." }, "middleName": { "type": [ "string", "null" ], "description": "Middle name from the barcode." }, "fullName": { "type": [ "string", "null" ], "description": "Full name from the barcode, combining first, middle, and last name." }, "suffix": { "type": [ "string", "null" ], "description": "Name suffix from the barcode (e.g. JR, SR)." }, "id": { "type": [ "string", "null" ], "description": "ID number from the barcode." }, "birthDate": { "type": [ "string", "null" ], "description": "Date of birth from the barcode.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "expireDate": { "type": [ "string", "null" ], "description": "Expiration date from the barcode.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "issueDate": { "type": [ "string", "null" ], "description": "Issue date from the barcode.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "streetAddress": { "type": [ "string", "null" ], "description": "Street address line 1 from the barcode." }, "streetAddress2": { "type": [ "string", "null" ], "description": "Street address line 2 from the barcode." }, "city": { "type": [ "string", "null" ], "description": "City from the barcode." }, "state": { "type": [ "string", "null" ], "description": "State/province from the barcode." }, "postalCode": { "type": [ "string", "null" ], "description": "Postal code from the barcode." }, "country": { "type": [ "string", "null" ], "description": "Country from the barcode." }, "class": { "type": [ "string", "null" ], "description": "The vehicle class from the barcode." }, "endorsements": { "type": [ "string", "null" ], "description": "The endorsements code from the barcode." } } }, "ocr_data": { "type": "object", "description": "Identity data extracted directly from the ID image.", "properties": { "firstName": { "type": [ "string", "null" ], "description": "The first name as read directly from the ID." }, "lastName": { "type": [ "string", "null" ], "description": "The last name as read directly from the ID." }, "middleName": { "type": [ "string", "null" ], "description": "The middle name as read directly from the ID." }, "fullName": { "type": [ "string", "null" ], "description": "The full name as read directly from the ID, combining first, middle, and last name." }, "id": { "type": [ "string", "null" ], "description": "The ID number as read directly from the ID." }, "birthDate": { "type": [ "string", "null" ], "description": "The date of birth as read directly from the ID.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "expireDate": { "type": [ "string", "null" ], "description": "The expiration date as read directly from the ID.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "issueDate": { "type": [ "string", "null" ], "description": "The issue date as read directly from the ID.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "address": { "type": [ "string", "null" ], "description": "The address as read directly from the ID." } } }, "confidences": { "type": "object", "properties": { "id": { "type": "number", "description": "Confidence score for an id photo.", "minimum": 0, "maximum": 1 }, "idQuality": { "type": "number", "description": "Confidence score for image quality of the id.", "minimum": 0, "maximum": 1 }, "idGlareQuality": { "type": "number", "description": "Confidence score for image quality of the id.", "minimum": 0, "maximum": 1 }, "selfie": { "type": [ "number", "null" ], "description": "Confidence score for a selfie photo.", "minimum": 0, "maximum": 1 }, "idMatch": { "type": [ "number", "null" ], "description": "Confidence score for matching data on the id.", "minimum": 0, "maximum": 1 }, "idExpired": { "type": "number", "description": "Confidence score for id expiration date.", "minimum": 0, "maximum": 1 }, "faceMatch": { "type": [ "number", "null" ], "description": "Confidence score for matching faces.", "minimum": 0, "maximum": 1 }, "birthDateMatch": { "type": [ "number", "null" ], "description": "Confidence score for matching birth dates.", "minimum": 0, "maximum": 1 }, "nameMatch": { "type": [ "number", "null" ], "description": "Confidence score for matching names.", "minimum": 0, "maximum": 1 }, "selfieSunglasses": { "type": "number", "description": "Confidence score for selfie with sunglasses.", "minimum": 0, "maximum": 1 }, "selfieEyeglasses": { "type": "number", "description": "Confidence score for selfie with eyeglasses.", "minimum": 0, "maximum": 1 }, "barcode": { "type": "number", "description": "Confidence score for decoding the barcode on the back of the id.", "minimum": 0, "maximum": 1 }, "barcodeMatch": { "type": "number", "description": "Confidence score for the barcode data matching the data read off the front of the id.", "minimum": 0, "maximum": 1 }, "liveness": { "type": "number", "description": "Confidence score for the liveness check on the selfie.", "minimum": 0, "maximum": 1 }, "livenessSession": { "type": [ "number", "null" ], "description": "Confidence score reported by the liveness session provider.", "minimum": 0, "maximum": 1 }, "voidedId": { "type": [ "number", "null" ], "description": "Confidence score that the id has not been voided.", "minimum": 0, "maximum": 1 }, "stableIdPattern": { "type": [ "number", "null" ], "description": "Confidence score that the submitted id is not part of a repeated submission pattern.", "minimum": 0, "maximum": 1 }, "stableSelfiePattern": { "type": [ "number", "null" ], "description": "Confidence score that the submitted selfie is not part of a repeated submission pattern.", "minimum": 0, "maximum": 1 }, "idAml": { "type": [ "number", "null" ], "description": "Confidence score derived from AML screening.", "minimum": 0, "maximum": 1 }, "idCrosscheckIdentity": { "type": "number", "description": "Confidence score for the CrossCheck identity match.", "minimum": 0, "maximum": 1 }, "idCrosscheckDarkweb": { "type": [ "number", "null" ], "description": "Confidence score derived from the dark web search.", "minimum": 0, "maximum": 1 }, "idCrosscheckActivity": { "type": [ "number", "null" ], "description": "Confidence score for CrossCheck identity activity.", "minimum": 0, "maximum": 1 } } }, "result": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Did the id verification completed successfully with no errors? The verification could have warnings. Reflects identity verification only; extracted fields such as `height`, `heightCm`, `eyeColor`, and `weight` may be `null` even when `success` is `true`." }, "successWithSuggestion": { "type": "boolean", "description": "Mirrors `success`. Retained for backwards compatibility — it is populated from the same underlying value and never diverges from `success`." }, "warnings": { "type": "boolean", "description": "Does the completed verification contain warnings." }, "gender": { "description": "Displays the gender stats for the Job.", "type": "object", "$ref": "#/components/schemas/gender_info" }, "clientOutput": { "description": "Displays information about the theme used, client and the capture type for the images.", "type": "object", "$ref": "#/components/schemas/client_data" }, "type": { "description": "The detected [id type](https://docs.vouched.id/docs/recognized-ids). For unrecognized ids, the type will be `other`.", "anyOf": [ { "$ref": "#/components/schemas/document_type" }, { "type": "null" } ] }, "state": { "type": "string", "description": "The issuing state/province/territory of the id as a [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2)." }, "country": { "type": "string", "description": "The issuing country of the id in [ISO 3166-1 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)." }, "id": { "type": "string", "description": "The verified id number of the id." }, "expireDate": { "type": "string", "description": "The verified expired date.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "issueDate": { "type": "string", "description": "The verified issued date.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "unverifiedIdAddress": { "type": "array", "description": "Unverified list of extracted address fields from the ID.", "items": { "type": "string" } }, "idType": { "type": "string", "description": "Any additional id type information available on the card." }, "ipFraudCheck": { "type": "object", "description": "Indicator of IP address fraud. The max attempts (default - 4) before a fraud check is triggered and the time range (default - 60 minutes) for the inspection is configurable.", "$ref": "#/components/schemas/ipFraudCheck" }, "address": { "type": [ "string", "null" ], "description": "The raw address line extracted from the id. Use `idAddress` for the parsed form." }, "idAddress": { "type": "object", "description": "The ID address.", "$ref": "#/components/schemas/address" }, "geoLocation": { "type": [ "object", "null" ], "description": "The device geolocation captured with the job, when supplied. `null` when not captured.", "properties": { "latitude": { "type": [ "number", "null" ], "description": "The captured latitude." }, "longitude": { "type": [ "number", "null" ], "description": "The captured longitude." }, "error": { "type": [ "string", "null" ], "description": "Why the device could not supply a location." } } }, "crosscheck": { "type": "object", "description": "The crosscheck result.", "$ref": "#/components/schemas/crosscheck_result" }, "aamva": { "type": "object", "description": "The aamva result.", "$ref": "#/components/schemas/aamva" }, "dlv": { "description": "The Driver's License Validation (DLV) result.", "$ref": "#/components/schemas/dlv" }, "featuresEnabled": { "description": "Which verification features were enabled and billable for this job.", "$ref": "#/components/schemas/features_enabled" }, "ipAddress": { "type": "object", "$ref": "#/components/schemas/ip_address" }, "aml": { "type": "object", "$ref": "#/components/schemas/aml" }, "class": { "type": "string", "description": "The ID class value." }, "idFields": { "type": "array", "description": "Array of objects containing available ID fields.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of available field." } } } }, "endorsements": { "type": "string", "description": "The id endorsements." }, "motorcycle": { "type": "string", "description": "The motorcycle property." }, "birthDate": { "type": "string", "description": "The verified date of birth.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "dob": { "type": "string", "description": "The verified date of birth. Duplicate of `birthDate`.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$" }, "firstName": { "type": "string", "description": "The user's verified first name." }, "middleName": { "type": "string", "description": "The user's verified middle name." }, "lastName": { "type": "string", "description": "The user's verified last name." }, "suffix": { "type": [ "string", "null" ], "description": "The name suffix extracted from the id (for example `JR`)." }, "height": { "type": [ "string", "null" ], "description": "The height extracted from the id (for example `5'-10\"` or `6-00`). May be `null` even when `success` is `true` if absent, illegible, or unparseable." }, "heightCm": { "type": [ "number", "null" ], "description": "The extracted height in centimeters. May be `null` even when `success` is `true` (see `height`)." }, "heightInch": { "type": [ "number", "null" ], "description": "The extracted height in inches. May be `null` even when `success` is `true` (see `height`)." }, "eyeColor": { "type": [ "string", "null" ], "description": "The eye color extracted from the id (for example `HAZ`, `BRO`). May be `null` even when `success` is `true` if absent, illegible, or not present on the id." }, "weight": { "type": [ "string", "null" ], "description": "The weight extracted from the id (for example `230`). May be `null` even when `success` is `true` if absent, illegible, or unparseable." }, "weightLb": { "type": [ "number", "null" ], "description": "The extracted weight in pounds. May be `null` even when `success` is `true` (see `weight`)." }, "weightKg": { "type": [ "number", "null" ], "description": "The extracted weight in kilograms. May be `null` even when `success` is `true` (see `weight`)." }, "barcodeData": { "type": "object", "description": "Identity data decoded from the barcode on the back of the ID.", "$ref": "#/components/schemas/barcode_data" }, "ocrData": { "type": "object", "description": "Identity data extracted directly from the ID image.", "$ref": "#/components/schemas/ocr_data" }, "hasPDF417Front": { "type": [ "boolean", "null" ], "description": "A PDF417 barcode was detected on the front of the id." }, "hasPDF417Back": { "type": [ "boolean", "null" ], "description": "A PDF417 barcode was detected on the back of the id." }, "captureBackId": { "type": [ "boolean", "null" ], "description": "The back of the id needs to be captured to complete the verification." }, "ocrBarcodeMismatches": { "type": "array", "description": "Fields that did not sufficiently match between the OCR-extracted identity and the decoded barcode data. Only populated when a barcode match error occurred.", "items": { "type": "string", "enum": [ "fullName", "birthDate", "id" ] } }, "confidences": { "type": "object", "description": "Confidence scores with a default threshold of 0.90", "$ref": "#/components/schemas/confidences" } } }, "error": { "type": "object", "properties": { "type": { "type": "string", "description": "\nError type code.\n- InvalidRequestError - The request is invalid.\n\n - Parameters sent in the request are invalid.\n\n\n- FaceMatchError - The face match score was lower than the threshold.\n\n - Category: faceMatch\n\n - Faces obtained from the ID and Selfie images do not match.\n\n\n- NameMatchError - The name match score was lower than the threshold.\n\n - The name provided by the user and the name extracted from the ID do not match.\n\n - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith\n\n\n- BarcodeMatchError - The barcode match score was lower than the threshold.\n\n - The data provided by the user and the data extracted from the barcode do not match. \n\n - Eg: User Provided Name - Dave Smith, Extracted Name - David Smith\n\n\n- BirthDateMatchError - The birth date match score was lower than the threshold.\n\n - The birth date provided by the user and the data extracted from the ID do not match.\n\n - Eg: User Provided DOB - 01/09/1992, Extracted DOB - 09/01/1992\n\n - Eg: User Provided DOB - 11/09/1992, Extracted DOB - 12/09/1992\n\n\n- ExpiredIdError - The ID’s expiration date has passed.\n\n - The expiration date extracted from the ID indicates that it has expired.\n\n- InvalidIdPhotoError - The ID is invalid.\n\n - Category: id\n\n - The image submitted does not qualify as an ID. The ID image may be of lower quality, have blur, glare or it may be too dark, and hence the data could not be extracted.\n\n- InvalidUserPhotoError - The user photo (selfie) is invalid.\n\n - Category: selfie\n\n - The image submitted does not qualify as a selfie.\n\n- BarcodeDetectError - The barcode could not be detected on the ID.\n- AuthenticationError - The request could not be authenticated.\n\n - The key could not be verified.\n\n- NotFoundError - The requested resource does not exist, or is not visible to this account.\n- AccountConfigErrorType - The feature is not enabled for this account.\n- SSNAccountConfigErrorType - SSN verification is not enabled for this account. Returned by the SSN endpoints in place of `AccountConfigErrorType`.\n- SSNUnprocessableEntityErrorType - The eCBSV request contains incorrectly formatted or missing data.\n- UnknownSystemError - A unknown system error occurred.\n- LivenessSkippedError - Selfie liveness was skipped.\n- LivenessScoreError - The selfie liveness score was below the threshold.\n- LivenessCompletionError - The selfie liveness check did not complete.\n- DarkWebError - The dark web check result was below the threshold.\n- ipAddressError - The IP address check result was below the threshold.\n- AMLError - The AML screening result was below the threshold.\n- MissingIdentityErrorType - No identity document was supplied.\n- RestrictedIdDocumentError - The identity document did not meet the account's configured constraints.\n- CrosscheckIdentityError - The CrossCheck identity score was below the threshold.\n- StableSelfiePatternError - An unstable selfie pattern was detected.\n- StableIdPatternError - An unstable ID pattern was detected.\n- DocumentVoidedError - The document has been voided.\n- DlvError - The ID did not pass Driver's License Verification.", "enum": [ "InvalidRequestError", "FaceMatchError", "NameMatchError", "BarcodeMatchError", "BarcodeDetectError", "BirthDateMatchError", "ExpiredIdError", "InvalidIdPhotoError", "InvalidUserPhotoError", "AuthenticationError", "NotFoundError", "AccountConfigErrorType", "SSNAccountConfigErrorType", "SSNUnprocessableEntityErrorType", "UnknownSystemError", "LivenessSkippedError", "LivenessScoreError", "LivenessCompletionError", "DarkWebError", "ipAddressError", "AMLError", "MissingIdentityErrorType", "RestrictedIdDocumentError", "CrosscheckIdentityError", "StableSelfiePatternError", "StableIdPatternError", "DocumentVoidedError", "DlvError" ] }, "message": { "type": "string", "description": "Details on the occurring error." }, "warning": { "type": "boolean", "description": "Is this a warning?" }, "suggestion": { "example": "John Smith", "description": "A suggestion for matching name.", "type": "string" } } }, "signals": { "type": "object", "properties": { "category": { "type": "string", "description": "Affected verification category.\n\nid: The id verification category scores indicate the value assigned(`result.confidences.id`) to the uploaded or capture ID image.\n\nselfie: The selfie verification category scores indicate the value assigned(`result.confidences.selfie`) to the uploaded or capture selfie image.\n\nfaceMatch: The faceMatch category score indicates the value assigned(`result.confidences.faceMatch`) to the face match between the ID and selfie images.\n\nbackId: The backId category score indicates the value assigned(`result.confidences.barcode`) to the uploaded or captured back ID image.", "enum": [ "faceMatch", "id", "selfie", "backId" ] }, "message": { "type": "string", "description": "Message associated with the signal." }, "type": { "type": "string", "description": "Signals affecting the score of the associated verification category. \n\nquality: Indicates the quality/bluriness of the image.\n\nbrightness: Indicates an image with low brightness. \n\nnonglare: Indicates an image with significant glare. \n\nglasses: Selfie image with the user wearing glasses affecting the face match score.\n\nface: Indicator of a face not being found in the image. \n\nfraud: Indicator of visual inconsistencies being found in the image.\n\nbarcode: Indicates a potential error/warning for the barcode scan.\n\nfieldConfidence: Indicates a lower confidence in the extracted values for the field/fields.\n\nmissingName: Indicates the missing field/fields.\n\ndeviceInfo: Provides information about the device used to capture or upload the image.\n\nsticker: Indicates a sticker obscuring the first/last name fields.", "enum": [ "quality", "brightness", "nonglare", "glasses", "face", "fraud", "barcode", "fieldConfidence", "missingName", "deviceInfo", "sticker" ] }, "fields": { "description": "An array of strings of the affected fields.", "type": "array" }, "property": { "description": "Property of the Signal.", "type": "string", "enum": [ "private", "public" ] } } }, "response_1": { "type": "object", "properties": { "id": { "type": "string", "description": "The job ID." }, "completed": { "type": "boolean", "description": "The job is completed." }, "status": { "type": "string", "description": "The job status", "enum": [ "active", "removed", "completed" ] }, "accountId": { "type": "string", "description": "The SID of the account the job belongs to." }, "accountGroupSid": { "type": [ "string", "null" ], "description": "The SID of the account group the job belongs to, or `null` when the job is not in a group." }, "submitted": { "type": "string", "example": "2019-09-07T15:50-04:00", "description": "The submitted date [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601)." }, "updatedAt": { "type": "string", "description": "The last updated date [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601).", "example": "2019-09-07T15:50-04:00" }, "reviewedAt": { "type": "string", "description": "The last updated review [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601).", "example": "2019-09-07T15:50-04:00" }, "reviewSuccess": { "type": "boolean", "description": "Review indicates the verification pass or failed." }, "accountReviewed": { "type": [ "boolean", "null" ], "description": "A reviewer on your account has marked the job as reviewed." }, "review": { "description": "Review override object.", "$ref": "#/components/schemas/job_review" }, "surveyPoll": { "type": "integer", "description": "User survey rating.", "minimum": 1, "maximum": 5 }, "surveyMessage": { "type": "string", "description": "User survey message." }, "surveyAt": { "type": "string", "description": "The [ISO8601 date](https://en.wikipedia.org/wiki/ISO_8601).", "example": "2019-09-07T15:50-04:00" }, "token": { "type": "string", "description": "The time limited session token for the job. Only present on session/token flows." }, "request": { "type": "object", "description": "Object for 'id-verification'.", "$ref": "#/components/schemas/request" }, "result": { "type": "object", "description": "Object for 'id-verification'.", "$ref": "#/components/schemas/result" }, "errors": { "type": "array", "description": "List of errors for unsuccessful completed jobs.", "items": { "$ref": "#/components/schemas/error" }, "example": [] }, "signals": { "type": "array", "description": "List of signals affecting id, backId, selfie and faceMatch scores.\n\n\n | Property | Associated Message |\n | ----------- | ----------- |\n | quality | ID/Selfie image is blurry |\n | brightness | ID/Selfie image is dark |\n | nonglare | ID/Selfie image has glare |\n | glasses | Sunglass/Eyeglass worn by user |\n | face | Required visual markers could not be detected |\n | fraud | Found visual inconsistencies |\n | barcode | Barcode data does not match extracted data, Barcode process was skipped, Unknown Barcode Error |\n | fieldConfidence | Field/Fields with low confidence: |\n | missingName | Missing Field/Fields: |\n | deviceInfo | Device Info: |\n | sticker | Property/Properties obscured by foreign material: |", "items": { "$ref": "#/components/schemas/signals" } }, "digitalCredential": { "type": [ "object", "null" ], "description": "Digital credential (mDL) session outcome. `null` when no digital credential session was used.", "properties": { "session": { "type": "object", "properties": { "done": { "type": "boolean", "description": "The session finished." }, "success": { "type": "boolean", "description": "The session finished successfully." }, "errorCode": { "type": [ "string", "null" ], "description": "Provider error code when the session failed." } } } } }, "nistCompliance": { "type": [ "object", "null" ], "description": "NIST 800-63A compliance summary. `null` when not evaluated.", "properties": { "ial2": { "type": "object", "description": "IAL2 compliance detail.", "properties": { "compliant": { "type": "boolean", "description": "The job satisfies IAL2." }, "consent": { "type": "boolean", "description": "The user gave the consent IAL2 requires." }, "realId": { "type": "boolean", "description": "The presented id is a REAL ID." }, "crosscheck": { "type": "object", "description": "CrossCheck evidence contributing to IAL2.", "properties": { "linked": { "type": "boolean", "description": "The identity was linked to a validated record." }, "phoneMatch": { "type": "boolean", "description": "The phone number matched." }, "emailMatch": { "type": "boolean", "description": "The email address matched." } } }, "phoneVerification": { "type": "object", "description": "Proof the applicant returned a code sent to the job's phone. Absent when none was recorded. Holds no phone number.", "properties": { "method": { "type": "string", "enum": [ "sms_otp" ], "description": "How possession was proven." }, "verifiedAt": { "type": "string", "format": "date-time", "description": "When the applicant returned the code." }, "recordedAt": { "type": "string", "format": "date-time", "description": "When Vouched stored the evidence." } } } } } } }, "rejectionReasons": { "type": "array", "description": "List of reasons why the verification was rejected.", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The unique key identifying the rejection reason." }, "description": { "type": "string", "description": "A description of the rejection reason." } } } } } }, "errors": { "type": "object", "description": "One or more errors describing why the request failed.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/error" } } } }, "token_error_response": { "type": "object", "description": "Returned by the JWT middleware, which runs ahead of all routers and so can answer any path. Note this is a single `error` string, not the `errors` array used by the rest of the API.", "properties": { "error": { "type": "string", "enum": [ "Token expired", "Token malformed" ] } } }, "apijobs_params": { "description": "Object for verification.", "type": "object", "properties": { "userPhoto": { "description": "The user's base64-encoded selfie photo. Supported types are `image/png`, `image/jpeg`. Required for full id-verification (ID+Selfie), selfie-verification, and id-reverification requests.", "type": "string" }, "idPhoto": { "description": "The user's base64-encoded photo of identification document (front). Supported types are `image/png`, `image/jpeg`. Required for id-verification requests.", "type": "string" }, "backIdPhoto": { "description": "The user's base64-encoded photo of identification document (back). Supported types are `image/png`, `image/jpeg`.", "type": "string" }, "enableCrossCheck": { "description": "Used to enable/disable crosscheck.", "type": "boolean" }, "enableDarkWeb": { "description": "Used to enable/disable dark web search.", "type": "boolean" }, "enableDriversLicenseValidation": { "description": "Used to disable Driver's License Verification (DLV) checks for an individual job. DLV is a premium feature that must be enabled on your account by Vouched; this parameter cannot enable DLV on accounts that do not have the feature. Set to `false` to skip DLV for this job.", "type": "boolean" }, "enableAML": { "description": "Used to enable/disable AML screening for an individual job. AML is a premium feature that must be enabled on your account by Vouched; this parameter cannot enable AML on accounts that do not have the feature.\n\n**Limitation:** this parameter is only honored when the request carries *none* of `firstName`, `lastName`, `dob`, `email`, `phone`, `clientData`, `geoLocation` or `consent`. If any of those is present, the stricter request schema applies and it does not permit `enableAML`, so the request is rejected with `400`.", "type": "boolean" }, "crosscheckReferenceId": { "description": "Reference id linking this job to a previously run CrossCheck.", "type": "string" }, "enableIPAddress": { "description": "Used to enable/disable IP address search.", "type": "boolean" }, "enablePhysicalAddress": { "description": "Used to enable/disable address search.", "type": "boolean" }, "firstName": { "description": "The user's first name to verify.", "type": "string" }, "lastName": { "description": "The user's last name to verify.", "type": "string" }, "dob": { "description": "The user's date of birth (MM/DD/YYYY) to verify.", "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$", "type": "string", "example": "07/02/1994" }, "email": { "description": "The user's email to verify (crosscheck only).", "type": "string", "example": "test@gmail.com" }, "phone": { "description": "The user's phone number to verify (crosscheck only).", "type": "string", "example": "000-111-2222" }, "ipaddress": { "description": "The user's IP address.", "type": "string" }, "internalId": { "description": "An internal identifier for the user within your organization. Must be unique within your account or specific account Group. Maximum length is 255 characters.", "type": "string" } } }, "body_4": { "type": "object", "description": "Note this body is not validated against a schema — the handler reads it directly, so unknown fields are accepted rather than rejected. Only `type` is enforced, by an explicit check.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of verification job.", "enum": [ "id-verification", "id-reverification", "selfie-verification" ] }, "callbackURL": { "type": "string", "description": "Upon the job's completion, Vouched will POST the job results to the defined webhook." }, "accountGroupSid": { "type": "string", "description": "Assign the job to an account group." }, "properties": { "type": "array", "description": "List of arbitrary customer supplied properties, echoed back on the job response and [webhook](https://docs.vouched.id/docs/webhooks) under `request.properties` so the result can be attributed in your own system.", "items": { "$ref": "#/components/schemas/apijobs_properties" } }, "params": { "description": "Optional. Defaults to an empty object. Required in practice for most requests — see the conditional rules on `idPhoto` and `userPhoto`.", "$ref": "#/components/schemas/apijobs_params" } } } }, "responses": { "400": { "description": "InvalidRequestError - The request is invalid. An aborted or oversized request is answered with this status and an empty body instead of the envelope below.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors" }, "example": { "errors": [ { "type": "InvalidRequestError", "message": "Invalid request" } ] } } } }, "401": { "description": "The request could not be authenticated. Credential rejection returns an `AuthenticationError` envelope; a malformed or expired bearer token is rejected earlier by the JWT middleware and returns `{ \"error\": \"Token expired\" }` or `{ \"error\": \"Token malformed\" }` instead.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/errors" }, { "$ref": "#/components/schemas/token_error_response" } ] }, "example": { "errors": [ { "type": "AuthenticationError", "message": "Unauthorized access" } ] } } } }, "404": { "description": "NotFoundError - The requested resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors" }, "example": { "errors": [ { "type": "NotFoundError", "message": "job not found" } ] } } } }, "500": { "description": "UnknownSystemError - A unknown system error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors" }, "example": { "errors": [ { "type": "UnknownSystemError", "message": "Oops, we encountered a problem" } ] } } } } } }, "x-tagGroups": [ { "name": "APIs", "tags": [ "jobs", "invites", "crosscheck", "aml", "ssn", "tin", "dob", "documents" ] }, { "name": "Internal", "tags": [ "client", "digital-id", "admin", "webhooks" ] } ] } ```