This guide explains how to create an order using Truv's API, allowing users to initiate and manage income and employment verifications efficiently.
To create an order using Truv's API, follow these steps:
1. Endpoint
- URL: Click on POST https://prod.truv.com/v1/orders/
2. Required Headers
- Enter X-Access-Client-Id: Your Client ID
- Enter X-Access-Secret: Your Access Secret
3. Request Body Parameters
Required Fields
- products: List of desired products (e.g., ["income"])
- first_name: Applicant's first name
- last_name: Applicant's last name
Optional Fields
- ssn: Applicant's Social Security Number (last 4 digits or full 9 digits)
- email: Applicant's email address
- phone: Applicant's mobile phone number
- employers: List of employer objects containing company_name
4. Response
A successful request returns a JSON response containing the order details, including a share_url that can be sent to the applicant for verification.
5. Notifications
- If email and/or phone are provided, Truv can send notifications to the applicant.
- If these fields are omitted, you'll need to manually share the share_url with the applicant.
6. Additional Considerations
- Ensure that the products field accurately reflects the services you require.
- Providing the SSN allows Truv to verify it against the payroll system.
- Specifying employers can streamline the verification process by directing the applicant to the correct employer.
By following these steps, you can effectively create an order using Truv's API, facilitating efficient income and employment verification processes.