Skip to main content
POST
/
v1
/
verification_sessions
Create a verification session
curl --request POST \
  --url https://api.yorlet.com/v1/verification_sessions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "types": [],
  "metadata": {},
  "client_reference_id": "<string>",
  "options": {
    "income": {
      "require_income_reference": true
    },
    "monitor": {
      "continuous_screening": true
    }
  },
  "provided_details": {
    "dob": {
      "day": 16,
      "month": 6.5,
      "year": 5949.5
    },
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>"
  },
  "related_customer": "<string>",
  "related_owner_person": "<string>",
  "return_url": "<string>",
  "send_email": false
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "verification_session",
  "completed_at": 123,
  "credit_check": {
    "next_action": {},
    "status": "<string>"
  },
  "identity": {
    "last_error": {
      "code": "<string>",
      "reason": "<string>"
    },
    "next_action": {
      "use_yorlet_sdk": {
        "client_secret": "<string>"
      }
    },
    "status": "<string>"
  },
  "income": {
    "next_action": {},
    "status": "<string>"
  },
  "monitor": {
    "next_action": {
      "type": "pending_identity"
    }
  },
  "options": {
    "identity": {
      "allowed_types": []
    },
    "income": {
      "affordability_check": {
        "amount": 123,
        "inverval_count": 123
      },
      "require_income_reference": true
    },
    "monitor": {
      "continuous_screening": true
    }
  },
  "provided_details": {
    "dob": {
      "day": 16,
      "month": 6.5,
      "year": 5949.5
    },
    "first_name": "<string>",
    "email": "[email protected]",
    "last_name": "<string>",
    "phone": "<string>"
  },
  "requirements": {
    "completed": [],
    "currently_due": []
  },
  "return_url": "<string>",
  "right_to_rent": {
    "next_action": {
      "dob_required": true
    }
  },
  "types": [],
  "url": "<string>",
  "verified_outputs": {
    "affordability": {
      "cost_to_income_ratio": 123
    },
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "verification_report": {
    "id": "<string>",
    "created": 123,
    "object": "verification_report",
    "identity": {
      "dob": {
        "day": 16,
        "month": 6.5,
        "year": 5949.5
      },
      "expiration_date": 123,
      "first_name": "<string>",
      "issuing_country": "<string>",
      "last_name": "<string>",
      "type": "<string>"
    },
    "income": {
      "affordability": {
        "cost_to_income_ratio": 123
      },
      "verification": {
        "bank_account": {
          "items": [
            {
              "bank_name": "<string>",
              "income_sources": [
                {
                  "category": "<string>",
                  "description": "<string>",
                  "total": 123
                }
              ]
            }
          ],
          "sources": 123,
          "total_monthly": 123,
          "total_yearly": 123
        },
        "document": {
          "items": [
            {
              "employer_name": "<string>",
              "employee_name": "<string>",
              "pay_stubs": [
                {
                  "gross_earnings": 123,
                  "net_pay": 123,
                  "pay_date": 123,
                  "pay_frequency": "<string>"
                }
              ]
            }
          ],
          "total_monthly": 123,
          "total_yearly": 123
        }
      }
    },
    "right_to_rent": {
      "dob": {
        "day": 16,
        "month": 6.5,
        "year": 5949.5
      },
      "share_code": "<string>"
    },
    "types": [],
    "verification_session": "<string>",
    "account": "<string>",
    "deleted": false
  },
  "account": "<string>",
  "deleted": false,
  "manually_reviewed": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
types
enum<string>[]
required

The verifications to include in this session.

Available options:
credit_check,
income,
identity,
right_to_rent
​
metadata
object

Set of key-value pairs that you can attach to the object.

​
client_reference_id
string

A client reference identifier to attach to the verification session.

​
options
object

Options to apply to the verification session.

​
provided_details
object

Details about the individual provided at session creation.

​
related_customer
string

The ID of the customer related to this verification session.

​
related_owner_person
string

The ID of the owner person related to this verification session.

​
return_url
string<uri>

The URL the user will be redirected to after completing verification.

​
send_email
boolean
default:false

Whether to send a verification email to the individual.

Response

200 - application/json

Returns the verification session object if the request succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
verification_session
​
completed_at
integer | null
required

The time at which the verification session was completed.

​
credit_check
object
required

Credit check details, when the session includes a credit check.

​
identity
object
required

Identity verification details, when the session includes identity verification.

​
income
object
required

Income verification details, when the session includes income verification.

​
monitor
object
required

Monitor verification details, when the session includes monitor verification.

​
options
object
required

Options applied to the verification session.

​
provided_details
object
required

Details provided by the individual at the start of the verification session.

​
requirements
object
required

Requirements for completing the verification session.

​
return_url
string | null
required

The URL the user will be redirected to after completing verification.

​
right_to_rent
object
required

Right-to-rent verification details, when the session includes a right-to-rent check.

​
status
enum<string>
required

The status of the verification session.

Available options:
pending,
complete,
canceled
​
types
enum<string>[]
required

The verifications included in this session.

Available options:
identity,
right_to_rent,
income,
credit_check,
monitor
​
url
string | null
required

The hosted URL the user can visit to complete verification.

​
verified_outputs
object
required

Verified outputs available once verification is complete.

​
verification_report
required

The verification report produced for this session, when available.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
manually_reviewed
boolean
default:false

Whether the verification session was manually reviewed.