Get All Verifications | Truework Docs

curl https://api.truework-sandbox.com/verification-requests \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <token>"

{
  "count": 253,
  "results": [
    {
      "created": "2021-12-20T18:50:20Z",
      "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
      "permissible_purpose": "child-support",
      "price": {
        "amount": "34.95"
      },
      "state": "pending-approval",
      "target": {
        "first_name": "Jane",
        "last_name": "Doe",
        "social_security_number": "***-**-0000"
      },
      "turnaround_time": {
        "best_estimate": "48",
        "lower_bound": "20",
        "upper_bound": "128"
      },
      "type": "employment-income",
      "use_case": "mortgage",
      "additional_information": "additional_information",
      "cancellation_details": "cancellation_details",
      "cancellation_reason": "immediate",
      "date_of_completion": "2021-12-20T18:50:20Z",
      "documents": [
        {
          "filename": "test.pdf"
        }
      ],
      "loan_id": "loan_id",
      "reports": [
        {
          "created": "2021-12-20T18:50:20Z",
          "current_as_of": "2021-12-20",
          "disputes": [
            {
              "created": "2021-12-20T18:50:20Z",
              "description": "Employee Title",
              "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
              "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
            }
          ],
          "employee": {
            "first_name": "Jane",
            "last_name": "Doe",
            "positions": [
              {
                "employment_type": "regular-full-time",
                "title": "Software Engineer"
              }
            ],
            "status": "active",
            "status_detail": "active",
            "earnings": [
              {
                "base": "35000.00",
                "bonus": "0.00",
                "commission": "100.25",
                "other": "0.00",
                "overtime": "200.00",
                "termination": false,
                "total": "35300.25",
                "year": "2020"
              }
            ],
            "salary": {
              "reduced_covid": "yes",
              "hours_per_week": "40",
              "months_per_year": "12"
            },
            "social_security_number": "***-**-0000"
          },
          "employer": {
            "name": "name",
            "government_ids": [
              {
                "id": "123456789",
                "type": "us-fein"
              }
            ]
          },
          "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
          "verification_request": {
            "created": "2021-12-20T18:50:20Z",
            "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
            "type": "employment-income"
          },
          "paystubs": [
            {
              "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
              "base": "7000.00",
              "bonus": "1000.00",
              "commission": "0.00",
              "gross": "8000.00",
              "net": "5500.00",
              "other": "0.00",
              "overtime": "0.00",
              "pay_period_hours": "86.67",
              "reference_id": "6894632654"
            }
          ]
        }
      ],
      "request_parameters": {
        "automated_underwriting_system_eligibility": "not-required",
        "employer_filter": "target-employer",
        "verification_methods": {
          "credentials": {
            "enabled": true
          },
          "instant": {
            "enabled": true
          },
          "smart_outreach": {
            "enabled": true
          }
        }
      },
      "reseller_originating_party": {
        "originating_party": "originating_party",
        "permissible_purpose": "child-support",
        "use_case": "mortgage"
      }
    }
  ],
  "next": "https://api.truework.com/resource?limit=25&offset=50",
  "previous": "https://api.truework.com/resource?limit=25"
}

A Verification is used to retrieve information about an employee's occupation and compensation. The individual requesting the verification is referred to as the Verifier, and the individual who is being verified is referred to as the Target.

Authentication

AuthorizationBearer

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

Query parameters

stateenumOptional

Filter returned verifications by state

associated_idstringOptional

Filter by associated ID

limitintegerOptionalDefaults to 25

Limit the number of results returned

offsetintegerOptionalDefaults to 0

Offset the results by page

Response

A list of Verifications was successfully retrieved.

countinteger

resultslist of objects

nextstring

previousstring

Errors

400

Get All Verifications Request Bad Request Error

401

Get All Verifications Request Unauthorized Error

403

Get All Verifications Request Forbidden Error

406

Get All Verifications Request Not Acceptable Error

429

Get All Verifications Request Too Many Requests Error

451

Get All Verifications Request Unavailable for Legal Reasons Error

500

Get All Verifications Request Internal Server Error

501

Get All Verifications Request Not Implemented Error

Authentication

Headers

Query parameters

Response

Errors