Get All Verifications | Truework Docs

{
  "count": 253,
  "next": "https://api.truework.com/resource?limit=25&offset=50",
  "previous": "https://api.truework.com/resource?limit=25",
  "results": [
    {
      "additional_information": "string",
      "branch_id": "5678",
      "cancellation_details": "string",
      "cancellation_reason": "immediate",
      "created": "2021-12-20T18:50:20.291247Z",
      "date_of_completion": "2021-12-20T18:50:20.291247Z",
      "documents": [
        {
          "filename": "test.pdf"
        }
      ],
      "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
      "loan_id": "string",
      "metadata": {},
      "permissible_purpose": "child-support",
      "price": {
        "amount": "34.95",
        "currency": "USD"
      },
      "reports": [
        {
          "additional_notes": "string",
          "created": "2021-12-20T18:50:20.291247Z",
          "current_as_of": "2021-12-20",
          "d1c_eligible": true,
          "disputes": [
            {
              "created": "2021-12-20T18:50:20.291247Z",
              "description": "Employee Title",
              "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
              "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
            }
          ],
          "du_reference_id": "string",
          "employee": {
            "earnings": [
              {
                "base": "35000.00",
                "bonus": "0.00",
                "commission": "100.25",
                "other": "0.00",
                "overtime": "200.00",
                "termination": false,
                "total": "35300.25",
                "year": "2020"
              }
            ],
            "email": "string",
            "first_name": "Jane",
            "hired_date": "2023-01-15",
            "last_name": "Doe",
            "on_leave_date": "2023-01-15",
            "positions": [
              {
                "employment_type": "regular-full-time",
                "end_date": "2023-01-15",
                "start_date": "2023-01-15",
                "title": "Software Engineer"
              }
            ],
            "salary": {
              "gross_pay": "string",
              "hours_per_week": "40",
              "months_per_year": "12",
              "pay_frequency": "biweekly",
              "reduced_covid": "yes"
            },
            "social_security_number": "***-**-0000",
            "status": "active",
            "status_detail": "active",
            "termination_date": "2023-01-15"
          },
          "employer": {
            "address": "string",
            "government_ids": [
              {
                "id": "123456789",
                "type": "us-fein"
              }
            ],
            "name": "string"
          },
          "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
          "income_analytics": {
            "annualized_income": {
              "amount": {
                "amount": "34.95",
                "currency": "USD"
              },
              "base_amount": {
                "amount": "34.95",
                "currency": "USD"
              },
              "gross_amount": {
                "amount": "34.95",
                "currency": "USD"
              },
              "short_employment_warning": true,
              "stale_data_warning": true,
              "variable_income_warning": true
            },
            "income_volatility": {
              "gross_income_volatility": "string"
            }
          },
          "paid_through_date": "2023-01-15",
          "paystubs": [
            {
              "base": "7000.00",
              "bonus": "1000.00",
              "commission": "0.00",
              "gross": "8000.00",
              "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
              "net": "5500.00",
              "other": "0.00",
              "overtime": "0.00",
              "pay_date": "2023-01-15",
              "pay_period_end_date": "2023-01-15",
              "pay_period_hours": "86.67",
              "pay_period_start_date": "2023-01-15",
              "reference_id": "6894632654"
            }
          ],
          "pricing_tier": "instant",
          "respondent": {
            "email": "string",
            "full_name": "string",
            "title": "string"
          },
          "verification_request": {
            "created": "2021-12-20T18:50:20.291247Z",
            "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
            "type": "employment"
          }
        }
      ],
      "request_parameters": {
        "employer_filter": "target-employer",
        "verification_methods": {
          "credentials": {
            "enabled": true
          },
          "instant": {
            "enabled": true
          },
          "smart_outreach": {
            "enabled": true
          }
        }
      },
      "reseller_originating_party": {
        "originating_party": "string",
        "permissible_purpose": "child-support",
        "use_case": "mortgage"
      },
      "state": "pending-approval",
      "target": {
        "company": {
          "address": "string",
          "city": "string",
          "id": 1,
          "name": "Example Inc.",
          "phone_number": "string",
          "state": "string",
          "zip_code": "string"
        },
        "contact_email": "string",
        "date_of_birth": "2023-01-15",
        "first_name": "Jane",
        "last_name": "Doe",
        "phone_number": "string",
        "social_security_number": "***-**-0000"
      },
      "turnaround_time": {
        "best_estimate": "48",
        "lower_bound": "20",
        "upper_bound": "128"
      },
      "type": "employment-income",
      "use_case": "mortgage"
    }
  ]
}

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 tokens conform to the RFC6750 spec.

Production API keys (secret keys) are prefixed with tw_sk_ and sandbox keys are prefixed with tw_sk_test_. If your secret key is published, you should rotate your API keys.

Truework.JS publishable keys are prefixed with tw_pk_ and tw_pk_test respectively.

Examples

For Authorization Headers: Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be
For the “try it now” token field, input only the token itself, omitting Bearer .

Bearer tokens conform to the [RFC6750](https://datatracker.ietf.org/doc/html/rfc6750#section-2.1) spec. Production API keys (secret keys) are prefixed with `tw_sk_` and sandbox keys are prefixed with `tw_sk_test_`. If your secret key is published, you should rotate your API keys. Truework.JS publishable keys are prefixed with `tw_pk_` and `tw_pk_test` respectively. **Examples** - For Authorization Headers: `Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be` - For the "try it now" `token` field, input only the token itself, omitting `Bearer `.

Query parameters

stateenumOptional

Filter returned verifications by state

associated_idstring or nullOptional

Filter by associated ID

limitintegerOptionalDefaults to 25

Limit the number of results returned

offsetintegerOptionalDefaults to 0

Offset the results by page

Response headers

Datestring

For JSON requests, the date at which the request was signed

X-Truework-Signaturestring

For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures

Response

A list of Verifications was successfully retrieved.

countinteger

nextstring or null

previousstring or null

resultslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

429

Too Many Requests Error

451

Unavailable for Legal Reasons Error

500

Internal Server Error

501

Not Implemented Error

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