Skip to main content
Create a new Verification

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

appId
string
required

Body

application/json

The information required to create a verification

consumerGroup
enum<string>
required

Enum of available consumer groups

Available options:
student,
graduate,
healthcare,
military,
first-responder,
charity-worker,
teacher,
parent,
low-income,
disability
territory
string
required

ISO 3166 Country Code

Pattern: ^[A-Z]{2}$
firstName
string
required

The first name of the user being verified

lastName
string
required

The last name of the user being verified

userEmail
string<email>
required

The email address of the user being verified

dob
string<date>
required

The date of birth for the user being verified

Response

Successful verification creation

verificationId
string<uuid>
required
appId
string
required
status
enum<string>
required
Available options:
success,
pending,
failed,
expired
stage
enum<string>
required

Enum of granular verification stages

Available options:
success,
failed:otp_failed,
failed:too_many_attempts,
phone_number,
phone_number_otp,
select_institution,
select_verification_method,
pending_verification:email,
pending_verification:manual,
pending_verification:portal,
rejected_verification:email,
rejected_verification:manual,
rejected_verification:portal
territory
string
required
Pattern: ^[A-Z]{2}$
consumerGroup
enum<string>
required

Enum of available consumer groups

Available options:
student,
graduate,
healthcare,
military,
first-responder,
charity-worker,
teacher,
parent,
low-income,
disability
availableMethods
enum<string>[]

Enum of available verification methods

Available options:
portal,
manual,
email,
inbound_email
institutionId
string
institutionName
string
createdAt
string<date-time>
updatedAt
string<date-time>
expiresOn
string<date>

YYYY-MM-DD

beansId
string

Internal Pion user ID.