POST requests create both an order and a verification. Returns a JSON object representing the newly created order and verification.
Employer search verifications are processed synchronously: Truework will attempt to process the verification during the initial POST request. If successful, the 201 response will include a reports key, which will contain the requested data.
It is recommended to set a timeout on synchronous requests, to account for potential latency when calling our partners. Synchronous requests generally take only a few seconds to complete, but in rare cases they may take longer.
This creates a verification request with the following attributes:
Comma-separated names of fields to include in the response. Separate multiple fields with commas, and denote subfields with parentheses. Multiple subfields from the same type can be listed within parentheses. In case of a list, subfields apply to each individual object. If omitted, all fields are included.
A valid purpose is required for Truework to process the verification request.
Throughout the API, this is signified by the permissible_purpose field.
The verification request use case describes the type of product the verification request is originating from. If omitted, the verifier type in account settings will be used as a default
A single level key-value JSON object that can be used to store custom data on the verification request; keys and values must be strings
The originating party that requested the verification via a reseller. reseller_originating_party is required for for companies that resell data provided by Truework.
A non-unique key that can be used to search for Orders
A non-unique key that can be used to search for Orders
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
Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1betoken field, input only the token itself, omitting Bearer .For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures