List all verification sessions
curl --request GET \
--url https://api.yorlet.com/v1/verification_sessions \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/verification_sessions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/verification_sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/verification_sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/verification_sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/verification_sessions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/verification_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"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,
"year": 5949
},
"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,
"year": 5949
},
"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,
"year": 5949
},
"share_code": "<string>"
},
"types": [],
"verification_session": "<string>",
"account": "<string>",
"deleted": false
},
"account": "<string>",
"deleted": false,
"manually_reviewed": false
}
]
}Verification Sessions
List all verification sessions
GET
/
v1
/
verification_sessions
List all verification sessions
curl --request GET \
--url https://api.yorlet.com/v1/verification_sessions \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/verification_sessions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/verification_sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/verification_sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/verification_sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/verification_sessions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/verification_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"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,
"year": 5949
},
"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,
"year": 5949
},
"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,
"year": 5949
},
"share_code": "<string>"
},
"types": [],
"verification_session": "<string>",
"account": "<string>",
"deleted": false
},
"account": "<string>",
"deleted": false,
"manually_reviewed": false
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of verification sessions.
Was this page helpful?
⌘I