Skip to main content
GET
/
v1
/
verification_sessions
List all verification sessions
curl --request GET \
  --url https://api.yorlet.com/v1/verification_sessions \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "verification_session",
      "completed_at": 123,
      "credit_check": {
        "next_action": {
          "type": "pending_identity"
        },
        "status": "<string>"
      },
      "identity": {
        "last_error": {
          "code": "<string>",
          "reason": "<string>"
        },
        "next_action": {
          "type": "use_yorlet_sdk",
          "use_yorlet_sdk": {
            "client_secret": "<string>"
          }
        },
        "status": "<string>"
      },
      "income": {
        "next_action": {
          "type": "pending_income"
        },
        "status": "<string>"
      },
      "options": {
        "identity": {
          "allowed_types": [
            "driving_licence"
          ]
        },
        "income": {
          "affordability_check": {
            "amount": 123,
            "interval": "month",
            "inverval_count": 123
          },
          "require_income_reference": true
        }
      },
      "provided_details": {
        "email": "[email protected]",
        "phone": "<string>"
      },
      "requirements": {
        "completed": [
          "credit_check"
        ],
        "currently_due": [
          "credit_check"
        ]
      },
      "return_url": "<string>",
      "right_to_rent": {
        "next_action": {
          "type": "pending_identity",
          "dob_required": true
        },
        "status": "requires_input",
        "type": "gb_resident"
      },
      "status": "pending",
      "types": [
        "identity"
      ],
      "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>",
          "status": "unverified",
          "type": "<string>"
        },
        "income": {
          "affordability": {
            "cost_to_income_ratio": 123
          },
          "status": "unverified",
          "type": "permanent_employment",
          "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
            },
            "type": "bank_account"
          }
        },
        "right_to_rent": {
          "dob": {
            "day": 16,
            "month": 6.5,
            "year": 5949.5
          },
          "dob_verification": "verified",
          "share_code": "<string>",
          "status": "unverified",
          "type": "gb_resident"
        },
        "status": "unverified",
        "types": [
          "identity"
        ],
        "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".

Response

200 - application/json

A object with a data property that contains an array of verification sessions.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required