Create a Verification
Creates a new Verification and return a JSON object representing the newly created Verification.
## Verification Processing
### Controlling Processing with the `Request-Sync` Header
Verifications are generally processed _asynchronously_: they will be created and returned in the response body without any [reports](api.yaml/paths/~1verification-requests~1{verification_id}~1report/get). Truework will then send a webhook when the request has finished processing, and the reports can be retrieved. However, **Instant** verifications (those which are created without a target company) can also be executed _synchronously_ by using the `Request-Sync` header. When processing 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.
This header can take one of the following values. If the header is not defined, the request will default to asynchronous execution.
| VALUE | DESCRIPTION |
| ----- | --------------------------------------- |
| sync | The request will execute synchronously |
| async | The request will execute asynchronously |
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.
Synchronous execution is only valid for requests that do not include a target company. Other requests that pass this header will return a `400` response.
### Controlling Processing with Request Parameters
Request parameters allow you to configure how you use Truework by selecting only the verification methods and features you need. If the `request_parameters` field is left blank, the default
behavior is:
- If `target.company` is included:
- Enable all verification methods
- Set `automated_underwriting_system_eligibility` to `not-required`
- Set `employer_filter` to `target-employer`
- If `target.company` is omitted:
- Only enable Truework Instant
- Set `automated_underwriting_system_eligibility` to `not-required`
- Set `employer_filter` to `all-employers` or `previous-employers`