Skip to main content
WEBHOOK

Headers

Idenfy-Event-Type
enum<string>
required
Available options:
IDENTIFICATION
Idenfy-Signature
string

Webhook signature

Body

application/json
final
boolean
required
platform
enum<string>
required
Available options:
PC,
MOBILE,
TABLET,
MOBILE_APP,
MOBILE_SDK,
OTHER
status
object
required

See Status Handling for what to do with overall, and especially how to handle a SUSPECTED result using fraudTags/mismatchTags.

data
object
required
fileUrls
object | null
required
scanRef
string
required
Maximum string length: 36
clientId
string
required
Maximum string length: 100
companyId
string
required
Maximum string length: 36
beneficiaryId
string
required
Maximum string length: 36
startTime
integer
required
finishTime
integer
required
clientIp
string | null
required
Maximum string length: 39
clientIpCountry
string | null
required
Maximum string length: 2
clientLocation
string | null
required
Maximum string length: 100
additionalStepPdfUrls
object | null
AML
object[] | null

Legacy (v2) object structure. If enabled, use amlCheck (v3), which better aligns with our new schema.

amlCheck
object | null
LID
object[] | null
CRIMINAL_CHECK
object[] | null
externalRef
string | null
Maximum string length: 40
gdcMatch
boolean | null
manualAddress
string | null
Maximum string length: 255
manualAddressMatch
boolean
registryCenterCheck
object
addressVerification
object | null
questionnaireAnswers
object | null
riskAssessment
object | null
bankVerification
object | null
emailVerification
object | null
phoneVerification
object | null
driverLicenseCheck
object | null
additionalSteps
object | null

Response

200

Return a 200 status to indicate that the data was received successfully.