account_id property. If the account is assigned to a group, the verification will automatically inherit that group. This can be overridden by supplying a group_id directly.
Identity verification must be enabled on your organisation before you can create verification requests.
Verification statuses
Thestatus property indicates the current state of the verification. Valid values include:
sent– The verification has been created and the individual is eligible to complete it.completed– The individual has submitted their identity documents and the request is finished.cancelled– The verification was cancelled before completion. The individual can no longer access it.
AML & CTF screening
Setscreening to true to include AML & CTF screening checks when the individual completes the verification. Screening compares the individual’s identity against sanctions and watchlists, politically exposed persons, adverse media, and other risk lists.
screening defaults to false. When enabled, a screening report is available from the Retrieve reports endpoint once the check has completed.
biometrics can be enabled independently of screening. When true, the individual must capture a live selfie that matches their identity document.
Muted verifications
Settingmuted to true disables all automatic correspondence from Annature to the individual.
This is commonly used when you want to control delivery of the verification link yourself. Muted verifications must still have an email address.
Verification tokens for muted individuals can be generated via the Retrieve a verification token endpoint.
Sharing and group visibility
Verification visibility is controlled by the sender’s group membership and theshared property.
When a verification is assigned to a group and marked as shared, other accounts in that group can view and manage it. A verification cannot be shared unless it belongs to a group.
Default sharing behaviour or forced sharing rules can be configured at the account level via the Annature dashboard.
Attributes
string
The unique identifier for the verification.
string(250)
The full name of the individual being verified.
string(250)
The individual’s email address, used for identification and correspondence.
string(100)
The individual’s mobile number, in E.164 format. Used to send an SMS with a link to open the verification.
string(100)
The mobile number used for SMS-based two-factor authentication, in E.164 format.When supplied, Annature will send a one-time code (OTP) that must be entered before the individual can access the verification.
string(1000)
The message body shown in the verification email. Supports placeholders such as
{{name}} and {{sender_business}}.See the full list of verification message bindings.string(1000)
The message body sent via SMS. Supports the same placeholders as
message, plus {{token}}, which is replaced with the verification link at send time.{{token}} is optional. If it is omitted, the SMS will not include a start link and the individual will need to open the verification from their email instead.See the full list of verification message bindings.string
Read-only string representing the verification’s current status.Possible values:
sent, completed, cancelled.string
The unique identifier of the account that created the verification.
string
The unique identifier of the group this verification is assigned to.If
shared is true, other accounts in this group can view and manage the verification.Indicates whether the verification is shared with other accounts in the same group as the sender.
string
Present when the individual’s identity documents could not be automatically verified and require manual review. This is a passthrough of Stripe’s Identity error codes.
boolean
If
true, Annature will not send any emails or SMS to the individual.boolean
Indicates whether AML & CTF screening checks are included on this verification.
boolean
Indicates whether the individual must capture a live selfie that matches their identity document.
string
The ISO 8601 timestamp for when the verification was created.
string
The ISO 8601 timestamp for when the verification was cancelled.
null if the verification has not been cancelled.string
The ISO 8601 timestamp for when the verification was completed.
null if the verification has not been completed.string
The ISO 8601 timestamp for when identity documents and PII stored with third parties are scheduled to be purged, based on your organisation’s data retention settings.
null if no purge is scheduled.string
The ISO 8601 timestamp for when identity documents and PII stored with third parties were purged.
null if the verification has not been purged.object
A set of key–value pairs that can be attached to the verification.Use this to store custom metadata in a structured format.