{ "opencollection": "1.0.0", "info": { "name": "Truv API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "X-Access-Client-Id", "value": "{{accessClientId}}", "in": "header" }, { "key": "X-Access-Secret", "value": "{{accessSecret}}", "in": "header" } ] } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Create a user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/users/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a user." }, { "info": { "name": "List users.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/users/" }, "docs": "List users." }, { "info": { "name": "Retrieve a user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/users/:user_id/", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a user." }, { "info": { "name": "Update a user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.truv.com/v1/users/:user_id/", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user." }, { "info": { "name": "Delete a user.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.truv.com/v1/users/:user_id/", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Delete a user." } ] }, { "info": { "name": "Bridge Tokens", "type": "folder" }, "items": [ { "info": { "name": "Create a bridge token for a user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/users/:user_id/tokens/", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a bridge token for a user." }, { "info": { "name": "Create a link-access token.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/link-access-tokens/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a link-access token." } ] }, { "info": { "name": "Links", "type": "folder" }, "items": [ { "info": { "name": "List links.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/" }, "docs": "List links." }, { "info": { "name": "Retrieve a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a link." }, { "info": { "name": "Delete a link.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.truv.com/v1/links/:link_id/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Delete a link." }, { "info": { "name": "Trigger a refresh task.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/refresh/tasks/", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger a refresh task." }, { "info": { "name": "Retrieve a refresh task.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/refresh/tasks/:task_id/", "params": [ { "name": "task_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a refresh task." } ] }, { "info": { "name": "Employment", "type": "folder" }, "items": [ { "info": { "name": "Retrieve employment data for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/employment/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve employment data for a link." }, { "info": { "name": "List all employments for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/employments/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "List all employments for a link." }, { "info": { "name": "Retrieve the employment verification report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/employment/report/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the employment verification report for a link." } ] }, { "info": { "name": "Income", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the income report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/income/report/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the income report for a link." }, { "info": { "name": "Retrieve the income transactions report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/income/transactions/reports/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the income transactions report for a link." }, { "info": { "name": "Create a report for a user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/users/:user_id/reports/:report_id/", "params": [ { "name": "user_id", "value": "", "type": "path" }, { "name": "report_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a report for a user." }, { "info": { "name": "Retrieve a report for a user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/users/:user_id/reports/:report_id/", "params": [ { "name": "user_id", "value": "", "type": "path" }, { "name": "report_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a report for a user." }, { "info": { "name": "Create an income insights report for a user.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/users/:user_id/income_insights/reports/:report_id/", "params": [ { "name": "user_id", "value": "", "type": "path" }, { "name": "report_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an income insights report for a user." }, { "info": { "name": "Retrieve an income insights report for a user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/users/:user_id/income_insights/reports/:report_id/", "params": [ { "name": "user_id", "value": "", "type": "path" }, { "name": "report_id", "value": "", "type": "path" } ] }, "docs": "Retrieve an income insights report for a user." } ] }, { "info": { "name": "Pay Statements", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a pay statement for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/statements/:statement_id/", "params": [ { "name": "link_id", "value": "", "type": "path" }, { "name": "statement_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a pay statement for a link." } ] }, { "info": { "name": "Direct Deposit", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the direct deposit report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/direct_deposit/report/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the direct deposit report for a link." }, { "info": { "name": "Retrieve the deposit switch report for a user.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/users/:user_id/deposit_switch/report/", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the deposit switch report for a user." } ] }, { "info": { "name": "Payroll & Shifts", "type": "folder" }, "items": [ { "info": { "name": "Retrieve shift data for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/shifts/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve shift data for a link." } ] }, { "info": { "name": "Insurance", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the insurance report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/insurance/report/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the insurance report for a link." }, { "info": { "name": "Retrieve the auto insurance report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/insurance/auto/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the auto insurance report for a link." }, { "info": { "name": "Retrieve the home insurance report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/insurance/home/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the home insurance report for a link." } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Create an order.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/orders/", "body": { "type": "json", "data": "{}" } }, "docs": "Create an order." }, { "info": { "name": "Look up an order.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/orders/lookup/", "body": { "type": "json", "data": "{}" } }, "docs": "Look up an order." }, { "info": { "name": "Retrieve an order.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/orders/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve an order." }, { "info": { "name": "Update an order.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/orders/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an order." }, { "info": { "name": "Partially update an order.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.truv.com/v1/orders/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update an order." }, { "info": { "name": "Cancel an order.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/orders/:id/cancel/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Cancel an order." }, { "info": { "name": "Add employers to an order.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/orders/:id/employers/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add employers to an order." }, { "info": { "name": "Retrieve events for an order.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/orders/:id/events/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve events for an order." }, { "info": { "name": "Retrieve certifications for an order.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/orders/:id/certifications/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve certifications for an order." } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "List tasks.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/tasks/" }, "docs": "List tasks." }, { "info": { "name": "Retrieve a task.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/tasks/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a task." } ] }, { "info": { "name": "Identity & Banking", "type": "folder" }, "items": [ { "info": { "name": "Retrieve identity data for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/identity/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve identity data for a link." }, { "info": { "name": "Retrieve banking auth data for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/auth/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve banking auth data for a link." }, { "info": { "name": "Retrieve account balances for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/balances/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve account balances for a link." }, { "info": { "name": "Retrieve bank accounts for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/bank_accounts/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve bank accounts for a link." }, { "info": { "name": "Retrieve bank statements for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/bank_statements/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve bank statements for a link." }, { "info": { "name": "Retrieve transactions for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/transactions/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve transactions for a link." }, { "info": { "name": "Retrieve investments for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/investments/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve investments for a link." }, { "info": { "name": "Retrieve liabilities for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/liabilities/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve liabilities for a link." }, { "info": { "name": "Retrieve a tax document for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/tax/:tax_id/", "params": [ { "name": "link_id", "value": "", "type": "path" }, { "name": "tax_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a tax document for a link." } ] }, { "info": { "name": "Companies & Providers", "type": "folder" }, "items": [ { "info": { "name": "Create a company.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/companies/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a company." }, { "info": { "name": "Retrieve a company.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/companies/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a company." }, { "info": { "name": "Search company mappings.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/company-mappings-search/" }, "docs": "Search company mappings." }, { "info": { "name": "Retrieve a provider.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/providers/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a provider." } ] }, { "info": { "name": "Templates", "type": "folder" }, "items": [ { "info": { "name": "List templates.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/templates/" }, "docs": "List templates." }, { "info": { "name": "Create a template.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/templates/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a template." }, { "info": { "name": "Retrieve a template.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/templates/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a template." }, { "info": { "name": "Update a template.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.truv.com/v1/templates/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a template." }, { "info": { "name": "Delete a template.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.truv.com/v1/templates/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a template." } ] }, { "info": { "name": "Admin", "type": "folder" }, "items": [ { "info": { "name": "Create an access key.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/keys/", "body": { "type": "json", "data": "{}" } }, "docs": "Create an access key." }, { "info": { "name": "Deactivate an access key.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/keys/deactivate/", "body": { "type": "json", "data": "{}" } }, "docs": "Deactivate an access key." } ] }, { "info": { "name": "PLL & Scoring", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the PLL report for a link.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/links/:link_id/pll/report/", "params": [ { "name": "link_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the PLL report for a link." }, { "info": { "name": "Create a scoring attributes report.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/scoring_attributes/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Create a scoring attributes report." }, { "info": { "name": "Retrieve a scoring attributes report.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/scoring_attributes/reports/:report_id", "params": [ { "name": "report_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a scoring attributes report." } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List webhooks.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/webhooks/" }, "docs": "List webhooks." }, { "info": { "name": "Create a webhook.", "type": "http" }, "http": { "method": "POST", "url": "https://prod.truv.com/v1/webhooks/", "body": { "type": "json", "data": "{}" } }, "docs": "Create a webhook." }, { "info": { "name": "Retrieve a webhook.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/webhooks/:webhook_id/", "params": [ { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a webhook." }, { "info": { "name": "Update a webhook.", "type": "http" }, "http": { "method": "PATCH", "url": "https://prod.truv.com/v1/webhooks/:webhook_id/", "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a webhook." }, { "info": { "name": "Delete a webhook.", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod.truv.com/v1/webhooks/:webhook_id/", "params": [ { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "Delete a webhook." }, { "info": { "name": "List webhook delivery requests.", "type": "http" }, "http": { "method": "GET", "url": "https://prod.truv.com/v1/webhook-requests/" }, "docs": "List webhook delivery requests." } ] } ], "bundled": true }