Metadata
A piece of metadata is additional data that's not a user's identity data (their identifiers or credentials) — though it's often about that identity data.
Metadata are outputs: we return them to you in API response bodies.
| Name | Key | Type | Applies To | Format | Description | Example |
|---|---|---|---|---|---|---|
| Verification Method | verificationMethod |
|
| snake_case | How an identifier or credential was verified | "phone_carrier" |
| Risk Signals | riskSignals | Object |
| Object with keys specified below in Risk Signals | Risk signals associated with the identifiers provided | See RiskSignals example |
What Verification Method Means
verificationMethod describes how a credential was verified:
"phone_carrier": verified via phone carrier records"credit_bureau": verified via credit bureau records"otp": verified via an OTP (one time passcode)"customer_otp": verified via an OTP (one time passcode) by a Verified customer, not directly by Verified"self_attested": attested by the user themselves (not verified)null
You can build custom logic to handle credentials based on their verificationMethod, for example requiring additional verification if an important credential is "self_attested".