Verification Types and Automatic Checks

Verification Types

Verification types allow you to select the scope of verification checks run against an individual, previously cases created via the Public API would use the default verification type of the organization. With this update you will be able to set the default verification type for the case.

Available Verification Types

The first step is querying the available verification types of the organiztion / office. This can be done via the me field, below is an example query.

query VerificationTypes {
	me {
		accessibleOrganizations {
			organizationId
			name
			individualVerificationTypes {
				verificationTypeId
				name
			}
			defaultIndividualVerificationType {
				verificationTypeId
				name
			}
			offices {
				key
				name
				individualVerificationTypes {
					verificationTypeId
					name
				}
				defaultIndividualVerificationType {
					verificationTypeId
					name
				}
			}
		}
	}
}

Specifiying the verification type

All case creation mutations such as CreateCaseInput now include a field individualVerificationType which allows you to specify the verification type that will be used for all individuals on the case. Note this field is an object that contains the verificationTypeId field. The input would look like the following:

{
    "input": {
        ... existing case creation fields
        "individualVerificationType": {
            "verificationTypeId": "1234" 
        }
    }
}

Automatically Run Checks

The mutation createCase (just this mutation) now supports requesting that all verification checks are automatically run after the case is created. This is via the runVerificationChecks field which is an enumeration and currently can be DO_NOT_RUN or RUN_ALL (the default is DO_NOT_RUN).

An important note is that we will only run the checks where the data is available for the individuals and entities, for example a KYC check requires a date of birth to be provided.


Getting Started
Authentication
Domain Concepts
API Features
Zapier
Embedded EIV
Help