Get One Report | Truework Docs

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

{
  "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": {
    "address": {
      "address": "1234 Rainbow Road",
      "city": "San Francisco",
      "country_code": "US",
      "country_subdivision_code": "CA",
      "extended_address": "Suite 300",
      "postal_code": "98265"
    },
    "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": {
      "hours_per_week": "40",
      "pay_frequency": "biweekly",
      "pay_rate": {
        "amount": "150000.00",
        "unit": "annually"
      },
      "reduced_covid": "yes"
    },
    "social_security_number": "***-**-0000",
    "status": "active",
    "status_detail": "active",
    "termination_date": "2023-01-15"
  },
  "employer": {
    "address": {
      "address": "1234 Rainbow Road",
      "city": "San Francisco",
      "country_code": "US",
      "country_subdivision_code": "CA",
      "extended_address": "Suite 300",
      "postal_code": "98265"
    },
    "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"
  }
}

Retrieves a Report for a given Verification id with multiple reports. If you don’t have the report id, it is recommended to use the embedded reports key from GET /verification-requests/{verification_id} to retrieve reports.

You can get the report in PDF format by adding Accept: application/pdf to your headers. When testing, please use the generated curl command with --output <PDF filename> specified.

<!— theme: info —>

Only completed Verifications have Reports associated with them. Any other request will fail with either 400 or 404, and provide more information as an attached error message. Reports are also embedded into the Verification object returned from get and get one.

Retrieves a Report for a given Verification id with multiple reports. If you don't have the report id, it is recommended to use the embedded `reports` key from `GET /verification-requests/{verification_id}` to retrieve reports. You can get the report in PDF format by adding `Accept: application/pdf` to your headers. When testing, please use the generated curl command with `--output <PDF filename>` specified.  > Only completed Verifications have Reports associated with them. Any other request will fail with either 400 or 404, and provide more information as an attached error message. > Reports are also embedded into the Verification object returned from get and get one.

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 `.

Path parameters

verification_request_idstringRequired

Verification ID

verification_report_idstringRequired

Report ID

Query parameters

income_analyticsbooleanOptionalDefaults to false

Whether to calculate income analytics for the nested reports in each verification.

fieldsstring or nullOptional

Comma-separated names of fields to include in the response. If omitted, all fields are included

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

additional_notesstring or null>=0 characters

createddatetime

current_as_ofdate

d1c_eligibleboolean or null

Returns true if this report is eligible for Day 1 Certainty

disputeslist of objects

Disputes that are currently open and relevant to this report

du_reference_idstring or null

This is the reference ID to submit to Fannie Mae for purposes of getting Day 1 Certainty

employeeobject

employerobject

idstring1-128 characters

income_analyticsobject or null

Calculated income features. Only returned if the income_analytics query parameter is provided and is true and the employee status on the report is active.

paid_through_datedate or null

The pay period end date of the most recent paystub (falling back to the pay date if no pay period end is set). This field is only populated for VOIE reports and will be null for non-VOIE reports or when no paystubs exist.

paystubslist of objects or null

Individual paystubs for each pay period. Paystubs are returned sorted in descending order from most recent to least recent pay date.

pricing_tierenum or null

respondentobject or null

verification_requestobject

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