{ "id": "9f2c1b7e4a3d4e8fa1b2c3d4e5f60718", "status": "completed", "order_count": 3, "created_count": 2, "failed_count": 1, "results": [ { "index": 0, "status": "created", "order_id": "39aa1486ccca4bc19cda071ffc1ba392", "order_number": "CASE-001", "bridge_token": "e4100fccdae94691b4414c7306220c06", "share_url": "https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06", "short_share_url": "https://truv.com/s/BIlEyh1A", "errors": { "last_name": [ "This field is required." ] } } ], "errors": [ { "detail": [ "The batch could not be processed." ] } ], "created_at": "2026-08-10T09:14:22.881Z", "updated_at": "2026-08-10T09:15:04.203Z"}
{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}
{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}
{
"detail": "Not Found."
}
Orders
Get order batch job status
The endpoint returns the state of a batch job and the outcome of every order in it.
While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.
Why the job as a whole could not run. Set only when status is failed, and null otherwise — errors for individual orders are in results[].errors instead.
Show child attributes
Example:
[ { "detail": ["The batch could not be processed."] } ]
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Truv","colors":{"primary":"#2C64E3","light":"#5A8AEF","dark":"#1E4BB8"},"logo":{"light":"https://mintcdn.com/truv/O5kzkDEe7x_ypnh0/logo/dark.svg?fit=max\u0026auto=format\u0026n=O5kzkDEe7x_ypnh0\u0026q=85\u0026s=4a88c1e43db8b515ffb08e5f87aafa65","dark":"https://mintcdn.com/truv/O5kzkDEe7x_ypnh0/logo/white.svg?fit=max\u0026auto=format\u0026n=O5kzkDEe7x_ypnh0\u0026q=85\u0026s=d611c5c17a34572abc853ebf93a96759","href":"/"},"favicon":"https://mintcdn.com/truv/z9uMK6PrkzslSpM_/favicon.ico?fit=max\u0026auto=format\u0026n=z9uMK6PrkzslSpM_\u0026q=85\u0026s=61f2e85e389d4ed41a43c6db75e7b406","api":{"openapi":"openapi.yaml","mdx":{"server":"https://prod.truv.com"}},"background":{"color":{"light":"#FFFFFF","dark":"#0F1117"}},"navbar":{"links":[{"href":"https://dashboard.truv.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get API Keys","href":"https://dashboard.truv.com"}},"footer":{"socials":{"twitter":"https://twitter.com/truv","linkedin":"https://www.linkedin.com/company/truv","github":"https://github.com/truvhq"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"truv","hasAudioNarration":false,"actualSubdomain":"truv","customDomains":["docs.truv.com"],"gitSource":{"type":"github","owner":"truvhq","repo":"mint-docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae968912a91f5d8b1c5d322","collectionId":"691364d1-7a81-4939-b702-0df7304c416e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae968912a91f5d8b1c5d322"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae968912a91f5d8b1c5d322","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Get Started","count":78},{"language":"default","tag":"Platform","count":71},{"language":"default","tag":"Mortgage","count":42},{"language":"default","tag":"Income \u0026 Employment","count":25},{"language":"default","tag":"Consumer Credit","count":25},{"language":"default","tag":"Implementation","count":23},{"language":"default","tag":"Financial Accounts","count":22},{"language":"default","tag":"Document Processing","count":19},{"language":"default","tag":"Public Sector","count":18}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@truv.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"coverage-search.css","content":".cw-widget{margin:.5rem 0 1.5rem}.cw-widget *{margin:0;padding:0;box-sizing:border-box}.cw-sb{position:relative;margin-bottom:.75rem}.cw-si{position:absolute;left:1rem;top:50%;transform:translateY(-50%);width:1.125rem;height:1.125rem;color:#9ca3af;pointer-events:none}.cw-input{width:100%;padding:.875rem 2.5rem .875rem 2.75rem;font-size:1rem;font-family:inherit;border:1.5px solid #e5e7eb;border-radius:12px;background:#fff;color:#111827;outline:0;box-sizing:border-box;transition:border-color .15s,box-shadow .15s}.cw-input:focus{border-color:#818cf8;box-shadow:0 0 0 4px rgba(129,140,248,.15)}.cw-input::placeholder{color:#9ca3af}.cw-clear{position:absolute;right:.75rem;top:50%;transform:translateY(-50%);display:flex;align-items:center;justify-content:center;background:0 0;border:0;cursor:pointer;padding:0;color:#9ca3af}.cw-ci{width:1.25rem;height:1.25rem}.cw-tabs{display:flex;flex-wrap:wrap;gap:.5rem;margin-bottom:1rem}.cw-tab{padding:.5rem 1rem;font-size:.875rem;font-family:inherit;font-weight:500;border:1.5px solid #e5e7eb;border-radius:999px;background:#fff;color:#374151;cursor:pointer;transition:all .15s}.cw-tab-active,.cw-tab:hover{border-color:#c7d2fe}.cw-tab-active{background:#eef2ff;color:#4338ca}.cw-ch{display:flex;justify-content:space-between;padding:.5rem 0;font-size:.8rem;color:#9ca3af;border-bottom:1px solid #f3f4f6}.cw-list{transition:opacity .15s}.cw-row,.cw-row-l{display:flex;align-items:center}.cw-row{justify-content:space-between;padding:.5rem 0;margin:0!important;border-bottom:1px solid #f3f4f6}.cw-row-l{gap:.75rem;flex:1;min-width:0}.cw-logo{width:36px;height:36px;border-radius:8px;object-fit:contain;flex-shrink:0;background:#f9fafb}.cw-logo-empty{background:#f3f4f6}.cw-name{font-size:.95rem;font-weight:500;color:#111827;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}.cw-rate{display:flex;align-items:center;justify-content:center;width:28px;height:28px;border-radius:50%;flex-shrink:0}.cw-rate-high{background:#dcfce7}.cw-rate-unk{background:#f3f4f6;color:#9ca3af;font-size:.85rem;font-weight:600}.cw-empty{text-align:center;padding:1.5rem 0!important;color:#6b7280;font-size:.9rem}.cw-foot{text-align:center;margin-top:.75rem}.cw-btn{padding:.625rem 1.5rem;font-size:.875rem;font-weight:500;font-family:inherit;border:1.5px solid #e5e7eb;border-radius:8px;background:#fff;color:#374151;cursor:pointer;transition:background .15s,border-color .15s}.cw-btn:hover{background:#f9fafb;border-color:#d1d5db}.dark .cw-input{background:#18181b;border-color:#3f3f46;color:#f4f4f5}.dark .cw-input:focus{border-color:#818cf8;box-shadow:0 0 0 4px rgba(129,140,248,.1)}.dark .cw-input::placeholder{color:#71717a}.dark .cw-clear{color:#71717a}.dark .cw-tab{background:#18181b;border-color:#3f3f46;color:#d4d4d8}.dark .cw-tab:hover{border-color:#6366f1}.dark .cw-tab-active{background:#1e1b4b;border-color:#6366f1;color:#a5b4fc}.dark .cw-ch{color:#71717a}.dark .cw-ch,.dark .cw-row{border-color:#27272a}.dark .cw-logo{background:#27272a}.dark .cw-logo-empty{background:#3f3f46}.dark .cw-name{color:#f4f4f5}.dark .cw-rate-high{background:#052e16}.dark .cw-rate-high svg{fill:#4ade80}.dark .cw-rate-unk{background:#27272a;color:#71717a}.dark .cw-empty{color:#a1a1aa}.dark .cw-btn{background:#18181b;border-color:#3f3f46;color:#d4d4d8}.dark .cw-btn:hover{background:#27272a;border-color:#52525b}"},{"filePath":"custom.css","content":"div.eyebrow{display:none!important}img.nav-logo{height:44px!important}.truv-topbar-group{display:inline-flex;align-items:center;gap:4px}.truv-resources-dropdown{position:relative;display:inline-flex;align-items:center}.truv-resources-btn{display:inline-flex;align-items:center;gap:2px;padding:6px 12px;background:0 0;border:0;color:inherit;font-size:14px;font-weight:500;cursor:pointer;font-family:inherit;white-space:nowrap}.truv-resources-btn:hover{opacity:.7}.truv-resources-menu{display:none;position:absolute;top:100%;right:0;margin-top:4px;min-width:160px;background:#fff;border:1px solid #e5e7eb;border-radius:8px;box-shadow:0 4px 12px rgba(0,0,0,.1);padding:4px;z-index:1000}.truv-resources-menu.open{display:block}.truv-resources-menu a{display:block;padding:8px 12px;color:#374151;text-decoration:none;font-size:14px;border-radius:6px;white-space:nowrap}.truv-resources-menu a:hover{background:#f3f4f6;color:#111827}.dark .truv-resources-menu,html[class*=dark] .truv-resources-menu{background:#1f2937;border-color:#374151}.dark .truv-resources-menu a,html[class*=dark] .truv-resources-menu a{color:#d1d5db}.dark .truv-resources-menu a:hover,html[class*=dark] .truv-resources-menu a:hover{background:#374151;color:#f9fafb}#content-area table td,#content-area table th{min-width:0}#content-area table code{white-space:nowrap}.coverage-table td,.coverage-table th{padding:10px 12px;text-align:left;vertical-align:middle}.coverage-table td:first-child,.coverage-table th:first-child{width:56px;text-align:center}.coverage-table td:nth-child(2),.coverage-table th:nth-child(2){width:110px}.coverage-table td:first-child img{display:block;margin:0 auto}:root{--mmd-line:#9CA3AF;--mmd-lifeline:#2C64E3;--mmd-node-fill:#EBF0FD;--mmd-node-border:#2C64E3;--mmd-node-text:#111827;--mmd-actor-fill:#2C64E3;--mmd-actor-border:#1E4BB8;--mmd-actor-text:#FFFFFF;--mmd-note-fill:#EBF0FD;--mmd-note-border:#5A8AEF;--mmd-note-text:#111827;--mmd-label-text:#111827;--mmd-label-bg:rgb(var(--background-light, 255 255 255))}.dark{--mmd-line:#9CA3AF;--mmd-lifeline:#5A8AEF;--mmd-node-fill:#16233B;--mmd-node-border:#5A8AEF;--mmd-node-text:#E5E7EB;--mmd-actor-fill:#2C64E3;--mmd-actor-border:#5A8AEF;--mmd-actor-text:#FFFFFF;--mmd-note-fill:#1E3A8A;--mmd-note-border:#5A8AEF;--mmd-note-text:#E5E7EB;--mmd-label-text:#E5E7EB;--mmd-label-bg:rgb(var(--background-dark, 15 17 23))}svg[id^=mermaid-] .edgePath .path,svg[id^=mermaid-] .flowchart-link,svg[id^=mermaid-] .loopLine,svg[id^=mermaid-] .messageLine0,svg[id^=mermaid-] .messageLine1,svg[id^=mermaid-] marker path{stroke:var(--mmd-line)!important}svg[id^=mermaid-] .actor-line{stroke:var(--mmd-lifeline)!important}svg[id^=mermaid-] marker path{fill:var(--mmd-line)!important}svg[id^=mermaid-] .node:not(.active):not(.error) circle,svg[id^=mermaid-] .node:not(.active):not(.error) path,svg[id^=mermaid-] .node:not(.active):not(.error) polygon,svg[id^=mermaid-] .node:not(.active):not(.error) rect{fill:var(--mmd-node-fill)!important;stroke:var(--mmd-node-border)!important}svg[id^=mermaid-] .node:not(.active):not(.error) .nodeLabel{fill:var(--mmd-node-text)!important;color:var(--mmd-node-text)!important}svg[id^=mermaid-] rect.actor{fill:var(--mmd-actor-fill)!important;stroke:var(--mmd-actor-border)!important}svg[id^=mermaid-] text.actor,svg[id^=mermaid-] text.actor tspan{fill:var(--mmd-actor-text)!important}svg[id^=mermaid-] .note{fill:var(--mmd-note-fill)!important;stroke:var(--mmd-note-border)!important}svg[id^=mermaid-] .noteText,svg[id^=mermaid-] .noteText tspan{fill:var(--mmd-note-text)!important}svg[id^=mermaid-] .labelText,svg[id^=mermaid-] .labelText tspan,svg[id^=mermaid-] .loopText,svg[id^=mermaid-] .loopText tspan,svg[id^=mermaid-] .messageText{fill:var(--mmd-label-text)!important;color:var(--mmd-label-text)!important}svg[id^=mermaid-] .edgeLabel,svg[id^=mermaid-] .edgeLabel p{color:var(--mmd-label-text)!important}svg[id^=mermaid-] .edgeLabel,svg[id^=mermaid-] .edgeLabel div,svg[id^=mermaid-] .edgeLabel foreignObject>div,svg[id^=mermaid-] .edgeLabel p,svg[id^=mermaid-] .edgeLabel rect,svg[id^=mermaid-] .edgeLabel span,svg[id^=mermaid-] .labelBkg,svg[id^=mermaid-] .labelBox{background-color:var(--mmd-label-bg)!important;fill:var(--mmd-label-bg)!important}svg[id^=mermaid-] .labelText,svg[id^=mermaid-] .loopText,svg[id^=mermaid-] .messageText{paint-order:stroke fill;stroke:var(--mmd-label-bg)!important;stroke-width:3px!important;stroke-linejoin:round}"}],"page":{"pagePath":"api-reference/orders/orders_batch_status","slug":"/api-reference/orders/orders_batch_status","pageMetadata":{"title":"Get order batch job status","openapi":"GET /v1/orders/batch/{id}/","description":"The endpoint returns the state of a batch job and the outcome of every order in it.\n\nWhile the job runs, `status` stays `pending` and `results` grows as orders are processed, so you can track progress. Once `status` is `completed`, every order has an entry in `results`: `created` for a new order, `existing` for one matched to an existing `order_number`, and `failed` with the validation errors for one that could not be created.","href":"/api-reference/orders/orders_batch_status"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The endpoint returns the state of a batch job and the outcome of every order in it.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"While the job runs, \", _jsx(_components.code, {\n children: \"status\"\n }), \" stays \", _jsx(_components.code, {\n children: \"pending\"\n }), \" and \", _jsx(_components.code, {\n children: \"results\"\n }), \" grows as orders are processed, so you can track progress. Once \", _jsx(_components.code, {\n children: \"status\"\n }), \" is \", _jsx(_components.code, {\n children: \"completed\"\n }), \", every order has an entry in \", _jsx(_components.code, {\n children: \"results\"\n }), \": \", _jsx(_components.code, {\n children: \"created\"\n }), \" for a new order, \", _jsx(_components.code, {\n children: \"existing\"\n }), \" for one matched to an existing \", _jsx(_components.code, {\n children: \"order_number\"\n }), \", and \", _jsx(_components.code, {\n children: \"failed\"\n }), \" with the validation errors for one that could not be created.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get order batch job status","openapi":"GET /v1/orders/batch/{id}/","description":"The endpoint returns the state of a batch job and the outcome of every order in it.\n\nWhile the job runs, `status` stays `pending` and `results` grows as orders are processed, so you can track progress. Once `status` is `completed`, every order has an entry in `results`: `created` for a new order, `existing` for one matched to an existing `order_number`, and `failed` with the validation errors for one that could not be created.","href":"/api-reference/orders/orders_batch_status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/truv/9a81556fef08db13/coverage-search.js","/_mintlify/custom/truv/c15dff2b800bd197/dev-footer.js"],"openApiReferenceData":{"operation":{"operationId":"orders_batch_status","summary":"Get order batch job status","description":"The endpoint returns the state of a batch job and the outcome of every order in it.\n\nWhile the job runs, `status` stays `pending` and `results` grows as orders are processed, so you can track progress. Once `status` is `completed`, every order has an entry in `results`: `created` for a new order, `existing` for one matched to an existing `order_number`, and `failed` with the validation errors for one that could not be created.","responses":{"200":"699c7ec6-adba-4f75-a378-87d06e9e7f9e","401":"4c40db97-402d-4fa9-8bdf-5141b9c0412e","403":"deb2528d-3c14-426e-a456-867c8cbca0a7","404":"e8f82295-ab22-4bd8-9845-38516d59df8d"},"tags":["Orders"],"method":"get","type":"path","servers":["d7e6ea9d-c4cf-44c3-ad8b-32589e5171fd"],"security":["a8520f3d-883f-4f87-ab37-99095e56e079"],"path":"/v1/orders/batch/{id}/","baseUrlOptions":["https://prod.truv.com"],"title":"Get order batch job status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"06e89ba7-52f4-428a-aa6f-8c31ba157d10":{"name":"id","in":"path","required":true,"description":"Batch job ID received from the POST request","schema":{"type":"string","isRequired":true,"description":"Batch job ID received from the POST request","uniqueKey":"","typeLabel":"string"},"example":"9f2c1b7e4a3d4e8fa1b2c3d4e5f60718"}},"responses":{"699c7ec6-adba-4f75-a378-87d06e9e7f9e":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Batch job ID. Use it to poll the job status.","example":"9f2c1b7e4a3d4e8fa1b2c3d4e5f60718","uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","description":"`pending` while orders are still being created, then `completed` once every order has an outcome, or `failed` if the whole job could not run.","enum":["pending","completed","failed"],"example":"completed","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"order_count":{"type":"integer","description":"Number of orders submitted in the request.","example":3,"uniqueKey":"order_count","typeLabel":"integer"},"created_count":{"type":"integer","description":"Number of orders that are usable, counting both `created` and `existing`.","example":2,"uniqueKey":"created_count","typeLabel":"integer"},"failed_count":{"type":"integer","description":"Number of orders that could not be created.","example":1,"uniqueKey":"failed_count","typeLabel":"integer"},"results":{"type":"array","description":"Outcome of each submitted order, matched to its position in the request.","items":{"type":"object","properties":{"index":{"type":"integer","description":"Zero-based position of the order in the request.","example":0,"uniqueKey":"results.items.[INDEX].index","typeLabel":"integer"},"status":{"type":"string","description":"`created` for a new order, `existing` when an order with the same `order_number` already existed, `failed` when the order could not be created.","enum":["created","existing","failed"],"example":"created","uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"order_id":{"oneOf":[{"type":"string","maxLength":32,"description":"ID of the created or existing order. Absent when the order failed.","example":"39aa1486ccca4bc19cda071ffc1ba392","uniqueKey":"results.items.[INDEX].order_id.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":32,"description":"ID of the created or existing order. Absent when the order failed.","example":"39aa1486ccca4bc19cda071ffc1ba392","uniqueKey":"results.items.[INDEX].order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].order_id","typeLabel":"string | null"},"order_number":{"oneOf":[{"type":"string","maxLength":512,"description":"Your identifier for the order, if one was sent.","example":"CASE-001","uniqueKey":"results.items.[INDEX].order_number.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":512,"description":"Your identifier for the order, if one was sent.","example":"CASE-001","uniqueKey":"results.items.[INDEX].order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].order_number","typeLabel":"string | null"},"bridge_token":{"oneOf":[{"type":"string","maxLength":32,"description":"Bridge token of the order.","example":"e4100fccdae94691b4414c7306220c06","uniqueKey":"results.items.[INDEX].bridge_token.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":32,"description":"Bridge token of the order.","example":"e4100fccdae94691b4414c7306220c06","uniqueKey":"results.items.[INDEX].bridge_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].bridge_token","typeLabel":"string | null"},"share_url":{"oneOf":[{"type":"string","maxLength":512,"description":"Verification link to share with the applicant.","example":"https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06","uniqueKey":"results.items.[INDEX].share_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":512,"description":"Verification link to share with the applicant.","example":"https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06","uniqueKey":"results.items.[INDEX].share_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].share_url","typeLabel":"string | null"},"short_share_url":{"oneOf":[{"type":"string","maxLength":512,"description":"Shortened verification link to share with the applicant.","example":"https://truv.com/s/BIlEyh1A","uniqueKey":"results.items.[INDEX].short_share_url.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":512,"description":"Shortened verification link to share with the applicant.","example":"https://truv.com/s/BIlEyh1A","uniqueKey":"results.items.[INDEX].short_share_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].short_share_url","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"object","description":"Why this order could not be created, keyed by field. Set only when `status` is `failed`.","example":{"last_name":["This field is required."]},"uniqueKey":"results.items.[INDEX].errors.oneOf.0","typeLabel":"object"},{"type":"null","description":"Why this order could not be created, keyed by field. Set only when `status` is `failed`.","example":{"last_name":["This field is required."]},"uniqueKey":"results.items.[INDEX].errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].errors","typeLabel":"object | null"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results","typeLabel":"object[]"},"errors":{"oneOf":[{"type":"array","description":"Why the job as a whole could not run. Set only when `status` is `failed`, and `null` otherwise — errors for individual orders are in `results[].errors` instead.","items":{"type":"object","properties":{"detail":{"type":"array","description":"Messages describing the failure.","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0.items.[INDEX].detail","typeLabel":"string[]"}},"uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[{"detail":["The batch could not be processed."]}],"uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Why the job as a whole could not run. Set only when `status` is `failed`, and `null` otherwise — errors for individual orders are in `results[].errors` instead.","items":{"type":"object","properties":{"detail":{"type":"array","description":"Messages describing the failure.","items":{"type":"string"}}}},"example":[{"detail":["The batch could not be processed."]}],"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"created_at":{"type":"string","format":"date-time","description":"Time the batch was accepted.","example":"2026-08-10T09:14:22.881Z","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Time the batch was last updated.","example":"2026-08-10T09:15:04.203Z","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"9f2c1b7e4a3d4e8fa1b2c3d4e5f60718","status":"completed","order_count":3,"created_count":2,"failed_count":1,"results":[{"index":0,"status":"created","order_id":"39aa1486ccca4bc19cda071ffc1ba392","order_number":"CASE-001","bridge_token":"e4100fccdae94691b4414c7306220c06","share_url":"https://cdn.truv.com/employment.html?bridge_token=e4100fccdae94691b4414c7306220c06","short_share_url":"https://truv.com/s/BIlEyh1A","errors":{"last_name":["This field is required."]}}],"errors":[{"detail":["The batch could not be processed."]}],"created_at":"2026-08-10T09:14:22.881Z","updated_at":"2026-08-10T09:15:04.203Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"4c40db97-402d-4fa9-8bdf-5141b9c0412e":{"description":"HTTP 401 Unauthorized","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"error":{"description":"","type":"object","properties":{"code":{"description":"","type":"string","example":"authentication_failed","uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"","type":"string","example":"No such token","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"authentication_failed","message":"No such token"}}}},"exampleType":"generated"}},"exampleType":"generated"},"deb2528d-3c14-426e-a456-867c8cbca0a7":{"description":"HTTP 403 Forbidden","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"error":{"description":"","type":"object","properties":{"code":{"description":"","type":"string","example":"not_authenticated","uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"","type":"string","example":"Authentication credentials were not provided.","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_authenticated","message":"Authentication credentials were not provided."}}}},"exampleType":"generated"}},"exampleType":"generated"},"e8f82295-ab22-4bd8-9845-38516d59df8d":{"description":"HTTP 404 Not Found","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"detail":{"description":"","type":"string","example":"Not Found.","uniqueKey":"detail","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"Not Found."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a8520f3d-883f-4f87-ab37-99095e56e079":{"ClientID":{"type":"apiKey","description":"Client ID","name":"X-Access-Client-Id","in":"header","scopes":[],"schemeName":"ClientID"},"AccessKey":{"type":"apiKey","description":"Client Access Key","name":"X-Access-Secret","in":"header","scopes":[],"schemeName":"AccessKey"}}},"servers":{"d7e6ea9d-c4cf-44c3-ad8b-32589e5171fd":{"url":"https://prod.truv.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Client ID","name":"X-Access-Client-Id","in":"header","scopes":[],"schemeName":"ClientID"},"schema":{"title":"X-Access-Client-Id","type":"string","description":"Client ID","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ClientID","name":"X-Access-Client-Id"},{"scheme":{"type":"apiKey","description":"Client Access Key","name":"X-Access-Secret","in":"header","scopes":[],"schemeName":"AccessKey"},"schema":{"title":"X-Access-Secret","type":"string","description":"Client Access Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessKey","name":"X-Access-Secret"}],"title":"ClientID \u0026 AccessKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"truv","siteName":"Truv","title":"Get order batch job status - Truv","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-14T15:11:07.818Z","originalFileLocation":"api-reference/orders/orders_batch_status.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The endpoint returns the state of a batch job and the outcome of every order in it. While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Truv\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get order batch job status - Truv\">\u003cmeta data-mint-head property=\"og:description\" content=\"The endpoint returns the state of a batch job and the outcome of every order in it. While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Truv\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.truv.com/api-reference/orders/orders_batch_status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://truv.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+order+batch+job+status\u0026amp;description=The+endpoint+returns+the+state+of+a+batch+job+and+the+outcome+of+every+order+in+it.%0A%0AWhile+the+job+runs%2C+%60status%60+stays+%60pending%60+and+%60results%60+grows+as+orders+\u0026amp;theme=1723ee55d07f48855b7cbd7f\u0026amp;signature=e566c42a37241b1490a144bcf2f63df431f784ce1d04d908720b4123922ed796\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get order batch job status - Truv\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The endpoint returns the state of a batch job and the outcome of every order in it. While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://truv.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+order+batch+job+status\u0026amp;description=The+endpoint+returns+the+state+of+a+batch+job+and+the+outcome+of+every+order+in+it.%0A%0AWhile+the+job+runs%2C+%60status%60+stays+%60pending%60+and+%60results%60+grows+as+orders+\u0026amp;theme=1723ee55d07f48855b7cbd7f\u0026amp;signature=e566c42a37241b1490a144bcf2f63df431f784ce1d04d908720b4123922ed796\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/truv/PBlsvTBzkVYuAN1i/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Truv\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2C64E3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.truv.com/api-reference/orders/orders_batch_status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/orders_batch_status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.truv.com/#organization\",\"name\":\"Truv\",\"url\":\"https://docs.truv.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/truv/O5kzkDEe7x_ypnh0/logo/dark.svg?fit=max\u0026auto=format\u0026n=O5kzkDEe7x_ypnh0\u0026q=85\u0026s=4a88c1e43db8b515ffb08e5f87aafa65\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.truv.com#website\",\"name\":\"Truv\",\"url\":\"https://docs.truv.com\",\"publisher\":{\"@id\":\"https://docs.truv.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.truv.com/api-reference/orders/orders_batch_status#webpage\",\"url\":\"https://docs.truv.com/api-reference/orders/orders_batch_status\",\"name\":\"Get order batch job status\",\"description\":\"The endpoint returns the state of a batch job and the outcome of every order in it. While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.\",\"dateModified\":\"2026-08-14T15:11:07.818Z\",\"isPartOf\":{\"@id\":\"https://docs.truv.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.truv.com/api-reference/orders/orders_batch_status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.truv.com/api-reference/orders/orders_batch_status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.truv.com/api-reference/data-structure\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Orders\",\"item\":\"https://docs.truv.com/api-reference/orders/object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get order batch job status\",\"item\":\"https://docs.truv.com/api-reference/orders/orders_batch_status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.truv.com/api-reference/orders/orders_batch_status#apireference\",\"headline\":\"Get order batch job status\",\"name\":\"Get order batch job status\",\"description\":\"The endpoint returns the state of a batch job and the outcome of every order in it. While the job runs, status stays pending and results grows as orders are processed, so you can track progress. Once status is completed, every order has an entry in results: created for a new order, existing for one matched to an existing order_number, and failed with the validation errors for one that could not be created.\",\"url\":\"https://docs.truv.com/api-reference/orders/orders_batch_status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.truv.com/api-reference/orders/orders_batch_status#webpage\"},\"dateModified\":\"2026-08-14T15:11:07.818Z\",\"publisher\":{\"@id\":\"https://docs.truv.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.truv.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Truv\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Truv","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/developers/home"}]},{"tab":"Mortgage","pages":[{"title":"Mortgage","href":"/mortgage/overview"}]},{"tab":"Public Sector","pages":[{"title":"Public Sector","href":"/government/overview"}]},{"tab":"Consumer Credit","pages":[{"title":"Consumer Credit","href":"/credit/overview"}]},{"tab":"Retail Banking","pages":[{"title":"Retail Banking","href":"/banking/overview"}]},{"tab":"Screening","pages":[{"title":"Screening","href":"/screening/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors \u0026 Rate Limits","href":"/api-reference/errors"},{"title":"Security","href":"/api-reference/security"},{"title":"OpenAPI Spec","sidebarTitle":"OpenAPI Spec","href":"/api-reference/openapi"},{"title":"SDK Overview","href":"/developers/sdks/overview"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"title":"Postman Collection","href":"/api-reference/postman"},{"title":"Report Sizes","href":"/api-reference/report-sizes"}]},{"group":"Platform","pages":[{"title":"Data Structure","sidebarTitle":"Data Structure","href":"/api-reference/data-structure"},{"title":"Data Processing","sidebarTitle":"Data Processing","href":"/api-reference/data-processing"},{"group":"Orders","pages":[{"title":"The Orders object","href":"/api-reference/orders/object"},{"title":"Order Webhook Events","href":"/api-reference/orders/events"},{"title":"Create an order","openapi":"POST /v1/orders/","href":"/api-reference/orders/orders_create"},{"title":"Create orders as a batch","openapi":"POST /v1/orders/batch/","description":"The endpoint accepts up to 10,000 orders in a single request and creates them in the background. It responds immediately with `202` and a job id — poll [the job status](/api-reference/orders/orders_batch_status) to get the result of each order, or subscribe to the [`order-batch-completed`](/api-reference/orders/events#order-batch-completed) webhook to be notified when the job finishes.\n\nEach order is processed on its own: valid orders are created and invalid ones are reported against their position in the request, so one bad order never blocks the rest.\n\n`order_number` must be unique within the environment. An order whose `order_number` already exists is skipped and reported as `existing`, with the id of the order that already holds that number — nothing is created and the existing order is left untouched. That makes retrying a batch safe.\n\nRate limits charge this endpoint per order, not per request: a batch of 500 orders costs 500 against the limit rather than 1. The batch endpoint has its own budget, separate from [create an order](/api-reference/orders/orders_create) — orders submitted in a batch leave the single-order budget untouched.\n\nThe limit is 3,000 orders per hour. A batch is charged in full when it is accepted, so a request holding more than 3,000 orders returns `429` even on an unused budget. Split larger uploads across requests, or [ask for a higher limit](/api-reference/errors#request-a-higher-limit).","href":"/api-reference/orders/orders_batch_create"},{"title":"Get order batch job status","openapi":"GET /v1/orders/batch/{id}/","href":"/api-reference/orders/orders_batch_status"},{"title":"List orders","openapi":"GET /v1/orders/","description":"The endpoint returns a list of orders.","href":"/api-reference/orders/orders_list"},{"title":"Get list of orders by SSN","openapi":"POST /v1/orders/lookup/","href":"/api-reference/orders/orders_list_lookup"},{"title":"Retrieve an order","openapi":"GET /v1/orders/{id}/","href":"/api-reference/orders/orders_read"},{"title":"Update an order","openapi":"PATCH /v1/orders/{id}/","href":"/api-reference/orders/orders_partial_update"},{"title":"Cancel an order","openapi":"POST /v1/orders/{id}/cancel/","href":"/api-reference/orders/orders_cancel_create"},{"title":"Create a data refresh order","openapi":"POST /v1/orders/{id}/","href":"/api-reference/orders/orders_create_refresh_order"},{"title":"Add new employer to the existing order","openapi":"POST /v1/orders/{id}/employers/","href":"/api-reference/orders/order-add-new-employer"},{"title":"Retrieve events for an order","openapi":"GET /v1/orders/{id}/events/","href":"/api-reference/orders/orders_events_list"},{"title":"Retrieve self-certification results for an order","openapi":"GET /v1/orders/{id}/certifications/","href":"/api-reference/orders/orders_certifications_results"},{"title":"Retrieve an order invoice","openapi":"GET /v1/orders/{id}/invoice/","href":"/api-reference/orders/order_group_invoice_detail"}]},{"group":"Users","pages":[{"title":"The Users object","href":"/api-reference/users/object"},{"title":"Create a user","openapi":"POST /v1/users/","href":"/api-reference/users/users_create"},{"title":"List all users","openapi":"GET /v1/users/","href":"/api-reference/users/users_list"},{"title":"Retrieve a user","openapi":"GET /v1/users/{user_id}/","href":"/api-reference/users/users_read"},{"title":"Update a user","openapi":"PATCH /v1/users/{user_id}/","href":"/api-reference/users/users_partial_update"},{"title":"Delete a user","openapi":"DELETE /v1/users/{user_id}/","href":"/api-reference/users/users_delete"}]},{"group":"Bridge Token","pages":[{"title":"The Bridge Token object","href":"/api-reference/bridge-token/object"},{"title":"Create a bridge token","openapi":"POST /v1/users/{user_id}/tokens/","href":"/api-reference/bridge-token/users_tokens"}]},{"group":"Tasks","pages":[{"title":"The Tasks object","href":"/api-reference/tasks/object"},{"title":"Task Lifecycle","href":"/api-reference/tasks/lifecycle"},{"title":"Task Webhook Events","href":"/api-reference/tasks/events"},{"title":"List all tasks","openapi":"GET /v1/tasks/","href":"/api-reference/tasks/tasks_list"},{"title":"Retrieve a task","openapi":"GET /v1/tasks/{id}/","href":"/api-reference/tasks/tasks_read"}]},{"group":"Data Refresh","pages":[{"title":"The Task Refresh object","href":"/api-reference/refresh/object"},{"title":"Create a data refresh task","openapi":"POST /v1/refresh/tasks/","href":"/api-reference/refresh/refresh_task_create"},{"title":"Retrieve a data refresh status","openapi":"GET /v1/refresh/tasks/{task_id}/","href":"/api-reference/refresh/refresh_task"}]},{"group":"Account Links","pages":[{"title":"The Account Links object","href":"/api-reference/links/object"},{"title":"Account Link Webhook Events","href":"/api-reference/links/events"},{"title":"List all links","openapi":"GET /v1/links/","href":"/api-reference/links/links-list"},{"title":"Retrieve a link","openapi":"GET /v1/links/{link_id}/","href":"/api-reference/links/links-item"},{"title":"Retrieve a link token","openapi":"POST /v1/link-access-tokens/","href":"/api-reference/links/link_exchange_token_flow"},{"title":"Delete a link","openapi":"DELETE /v1/links/{link_id}/","href":"/api-reference/links/delete_link_by_link_id"}]},{"group":"Companies","pages":[{"title":"The Companies object","href":"/api-reference/companies/object"},{"title":"Search companies","openapi":"POST /v1/companies/","href":"/api-reference/companies/company_mapping"},{"title":"Get company information","openapi":"GET /v1/companies/{company_mapping_id}/","href":"/api-reference/companies/company_info"},{"title":"Search companies with autocomplete","openapi":"GET /v1/company-mappings-search/","href":"/api-reference/companies/company_autocomplete_search"}]},{"group":"Data Providers","pages":[{"title":"The Data Providers object","href":"/api-reference/data-providers/object"},{"title":"List all data providers","openapi":"GET /v1/providers/","href":"/api-reference/data-providers/providers-list"},{"title":"Retrieve a data provider","openapi":"GET /v1/providers/{id}/","href":"/api-reference/data-providers/providers-detail"}]},{"group":"UX Customization","pages":[{"title":"The Templates object","href":"/api-reference/templates/object"},{"title":"Create a customization template","openapi":"POST /v1/templates/","href":"/api-reference/templates/templates_create"},{"title":"List all customization templates","openapi":"GET /v1/templates/","href":"/api-reference/templates/templates_list"},{"title":"Retrieve a customization template","openapi":"GET /v1/templates/{template_id}/","href":"/api-reference/templates/templates_read"},{"title":"Update a customization template","openapi":"PATCH /v1/templates/{template_id}/","href":"/api-reference/templates/templates_partial_update"},{"title":"Delete a customization template","openapi":"DELETE /v1/templates/{template_id}/","href":"/api-reference/templates/templates_delete"}]},{"group":"Sandbox","pages":[{"title":"The Sandbox Scenario object","href":"/api-reference/sandbox/object"},{"title":"Create a sandbox scenario","openapi":"POST /v1/sandbox/scenarios/","href":"/api-reference/sandbox/v1_sandbox_scenarios_create"},{"title":"List sandbox scenarios","openapi":"GET /v1/sandbox/scenarios/","href":"/api-reference/sandbox/v1_sandbox_scenarios_list"},{"title":"Retrieve a sandbox scenario","openapi":"GET /v1/sandbox/scenarios/{scenario_id}/","href":"/api-reference/sandbox/v1_sandbox_scenarios_read"},{"title":"Update a sandbox scenario","openapi":"PATCH /v1/sandbox/scenarios/{scenario_id}/","href":"/api-reference/sandbox/v1_sandbox_scenarios_partial_update"},{"title":"Delete a sandbox scenario","openapi":"DELETE /v1/sandbox/scenarios/{scenario_id}/","href":"/api-reference/sandbox/v1_sandbox_scenarios_delete"},{"title":"Resolve a sandbox scenario","openapi":"POST /v1/sandbox/scenarios/resolve/","href":"/api-reference/sandbox/v1_sandbox_scenarios_resolve"},{"title":"Upload a sandbox document","openapi":"POST /v1/sandbox/documents/","href":"/api-reference/sandbox/v1_sandbox_documents_create"},{"title":"List sandbox documents","openapi":"GET /v1/sandbox/documents/","href":"/api-reference/sandbox/v1_sandbox_documents_list"},{"title":"Retrieve a sandbox document","openapi":"GET /v1/sandbox/documents/{document_id}/","href":"/api-reference/sandbox/v1_sandbox_documents_read"},{"title":"Update a sandbox document","openapi":"PATCH /v1/sandbox/documents/{document_id}/","href":"/api-reference/sandbox/v1_sandbox_documents_partial_update"},{"title":"Delete a sandbox document","openapi":"DELETE /v1/sandbox/documents/{document_id}/","href":"/api-reference/sandbox/v1_sandbox_documents_delete"}]},{"group":"Key Management","hidden":true,"pages":[{"title":"The Key Management object","href":"/api-reference/keys/object"},{"title":"Create an API key","openapi":"POST /v1/keys/","href":"/api-reference/keys/keys-create"},{"title":"Deactivate an API key","openapi":"POST /v1/keys/deactivate/","href":"/api-reference/keys/keys-deactivate"}]},{"group":"Webhook Endpoints","pages":[{"title":"The Webhook Endpoint object","href":"/api-reference/webhooks/object"},{"title":"Create a webhook endpoint","openapi":"POST /v1/webhooks/","href":"/api-reference/webhooks/webhooks_create"},{"title":"List all webhook endpoints","openapi":"GET /v1/webhooks/","href":"/api-reference/webhooks/webhooks_list"},{"title":"Retrieve a webhook endpoint","openapi":"GET /v1/webhooks/{webhook_id}/","href":"/api-reference/webhooks/webhooks_read"},{"title":"Update a webhook endpoint","openapi":"PATCH /v1/webhooks/{webhook_id}/","href":"/api-reference/webhooks/webhooks_partial_update"},{"title":"Delete a webhook endpoint","openapi":"DELETE /v1/webhooks/{webhook_id}/","href":"/api-reference/webhooks/webhooks_delete"},{"title":"List webhook request history","openapi":"GET /v1/webhook-requests/","href":"/api-reference/webhooks/webhook_requests_list"}]}]},{"group":"Income \u0026 Employment","pages":[{"group":"User Income and Employment Report","pages":[{"title":"The User Income \u0026 Employment Reports object","href":"/api-reference/user-income-and-employment-reports/object"},{"title":"Create an income and employment report","openapi":"POST /v1/users/{user_id}/reports/","href":"/api-reference/user-income-and-employment-reports/users_reports"},{"title":"Retrieve an income and employment report","openapi":"GET /v1/users/{user_id}/reports/{report_id}/","href":"/api-reference/user-income-and-employment-reports/users_get_report"}]},{"group":"Link Income and Employment Report","pages":[{"title":"The Link Income \u0026 Employment Reports object","href":"/api-reference/account-link-income-and-employment-reports/object"},{"title":"Retrieve an income and employment report for a link","openapi":"GET /v1/links/{link_id}/income/report/","href":"/api-reference/account-link-income-and-employment-reports/link_detail_reports_income"},{"title":"Retrieve an employment history report for a link","openapi":"GET /v1/links/{link_id}/employment/report/","href":"/api-reference/account-link-income-and-employment-reports/link_detail_reports_employment"}]},{"group":"Benefit Letters","pages":[{"title":"List all benefit letters","openapi":"GET /v1/links/{link_id}/benefit_letters/","href":"/api-reference/benefit-letters/benefit-letters"},{"title":"Retrieve benefit letter","openapi":"GET /v1/links/{link_id}/benefit_letters/{benefit_letter_id}/","href":"/api-reference/benefit-letters/benefit-letter"}]},{"group":"Employment","pages":[{"title":"The Employment object","href":"/api-reference/employment/object"},{"title":"Employment Webhook Events","href":"/api-reference/employment/events"},{"title":"List all employments","openapi":"GET /v1/links/{link_id}/employments/","href":"/api-reference/employment/link-employments"},{"title":"Retrieve an employment","openapi":"GET /v1/links/{link_id}/employment/","href":"/api-reference/employment/link-last-employment"}]},{"group":"Identity","pages":[{"title":"The Identity object","href":"/api-reference/identity/object"},{"title":"Identity Webhook Events","href":"/api-reference/identity/events"},{"title":"Retrieve an identity","openapi":"GET /v1/links/{link_id}/identity/","href":"/api-reference/identity/link-identity"}]},{"group":"Pay Statements","pages":[{"title":"The Pay Statements object","href":"/api-reference/statements/object"},{"title":"Pay Statement Webhook Events","href":"/api-reference/statements/events"},{"title":"List all statements","openapi":"GET /v1/links/{link_id}/statements/","href":"/api-reference/statements/link-statements"},{"title":"Retrieve a statement","openapi":"GET /v1/links/{link_id}/statements/{statement_id}/","href":"/api-reference/statements/retrieve-statement"}]},{"group":"Shifts","pages":[{"title":"The Shifts object","href":"/api-reference/shifts/object"},{"title":"Shift Webhook Events","href":"/api-reference/shifts/events"},{"title":"List all shifts","openapi":"GET /v1/links/{link_id}/shifts/","href":"/api-reference/shifts/link-shifts"}]},{"group":"Tax Documents","pages":[{"title":"The Tax Documents object","href":"/api-reference/tax/object"},{"title":"List all tax documents","openapi":"GET /v1/links/{link_id}/tax/","href":"/api-reference/tax/tax-documents"},{"title":"Retrieve tax document","openapi":"GET /v1/links/{link_id}/tax/{tax_id}/","href":"/api-reference/tax/tax-document"}]}]},{"group":"Financial Accounts","pages":[{"group":"User Assets Report","pages":[{"title":"The User Asset Reports object","href":"/api-reference/user-asset-verification-reports/object"},{"title":"Create an assets report","openapi":"POST /v1/users/{user_id}/assets/reports/","href":"/api-reference/user-asset-verification-reports/assets-report-create"},{"title":"Retrieve an assets report","openapi":"GET /v1/users/{user_id}/assets/reports/{report_id}/","href":"/api-reference/user-asset-verification-reports/assets-report-retrieve"}]},{"group":"Bank Income Report","pages":[{"title":"The Bank Income Report Object","href":"/api-reference/bank-income-insights/object"},{"title":"Retrieve the most recent bank income report","openapi":"GET /v1/links/{link_id}/income/transactions/reports/","href":"/api-reference/bank-income-insights/bank-income-report-retrieve"}]},{"group":"User Income Insights Report","pages":[{"title":"The User Income Insights object","href":"/api-reference/income-insights/object"},{"title":"Create a user bank income insights report","openapi":"POST /v1/users/{user_id}/income_insights/reports/","href":"/api-reference/income-insights/income-insights-report-create"},{"title":"Retrieve a user bank income insights report","openapi":"GET /v1/users/{user_id}/income_insights/reports/{report_id}/","href":"/api-reference/income-insights/income-insights-report-retrieve"}]},{"group":"Auth","pages":[{"title":"The Auth object","href":"/api-reference/auth/object"},{"title":"Retrieve auth data","openapi":"GET /v1/links/{link_id}/auth/","href":"/api-reference/auth/bank-auth-get"}]},{"group":"Balances","pages":[{"title":"The Balances object","href":"/api-reference/balances/object"},{"title":"List all balances","openapi":"GET /v1/links/{link_id}/balances/","href":"/api-reference/balances/balances-list"}]},{"group":"Transactions","pages":[{"title":"The Transactions object","href":"/api-reference/transactions/object"},{"title":"List all bank transactions","openapi":"GET /v1/links/{link_id}/transactions/","href":"/api-reference/transactions/link-bank-data-transactions"}]},{"group":"Recurring Transactions","pages":[{"title":"Retrieve recurring transactions (inflows and outflows) for a user","openapi":"GET /v1/users/{user_id}/transactions/recurring/","href":"/api-reference/recurring-transactions/applicant-recurring-transactions"}]},{"group":"Bank Statements","pages":[{"title":"List all bank statements","openapi":"GET /v1/links/{link_id}/bank_statements/","href":"/api-reference/bank-statements/link-bank-statements"}]},{"group":"Investments","pages":[{"title":"List all investment holdings","openapi":"GET /v1/links/{link_id}/investments/","href":"/api-reference/investments/link-investments-list"}]},{"group":"Liabilities","pages":[{"title":"The Liabilities object","href":"/api-reference/liabilities/object"},{"title":"Retrieve liabilities","openapi":"GET /v1/links/{link_id}/liabilities/","href":"/api-reference/liabilities/link_liabilities"}]},{"group":"Scoring Attributes Reports","pages":[{"title":"The Scoring Attributes Report object","href":"/api-reference/scoring-attributes/object"},{"title":"Create a scoring attributes report","openapi":"POST /v1/scoring_attributes/reports","href":"/api-reference/scoring-attributes/scoring-attributes-report-create"},{"title":"Retrieve a scoring attributes report","openapi":"GET /v1/scoring_attributes/reports/{report_id}","href":"/api-reference/scoring-attributes/scoring-attributes-report-retrieve"}]}]},{"group":"Document Processing","pages":[{"group":"Document Collections","pages":[{"title":"The Document Collections object","href":"/api-reference/document-collections/object"},{"title":"Document Collection Webhook Events","href":"/api-reference/document-collections/events"},{"title":"Create a new document collection","openapi":"POST /v1/documents/collections/","href":"/api-reference/document-collections/collections_create"},{"title":"Get document collection details","openapi":"GET /v1/documents/collections/{collection_id}/","href":"/api-reference/document-collections/collections_retrieve"},{"title":"List all document collections","openapi":"GET /v1/documents/collections/","href":"/api-reference/document-collections/collections_list"},{"title":"Upload files to existing collection","openapi":"POST /v1/documents/collections/{collection_id}/upload/","href":"/api-reference/document-collections/collections_upload"},{"title":"Get uploaded file details","openapi":"GET /v1/documents/collections/{collection_id}/upload/{uploaded_file_id}/","href":"/api-reference/document-collections/collections_uploaded_file_retrieve"},{"title":"Finalize a collection","openapi":"POST /v1/documents/collections/{collection_id}/finalize/","href":"/api-reference/document-collections/collections_finalize_create"},{"title":"Get collection finalization results","openapi":"GET /v1/documents/collections/{collection_id}/finalize/","href":"/api-reference/document-collections/collections_finalize_retrieve"},{"title":"Delete an uploaded file","openapi":"DELETE /v1/documents/collections/{collection_id}/upload/{uploaded_file_id}/","href":"/api-reference/document-collections/collections_uploaded_file_delete"},{"title":"Delete a document collection","openapi":"DELETE /v1/documents/collections/{collection_id}/","href":"/api-reference/document-collections/collections_delete"}]},{"group":"Uploaded Documents","pages":[{"title":"The Uploaded Documents object","href":"/api-reference/uploaded-documents/object"},{"title":"List all documents","openapi":"GET /v1/links/{link_id}/documents/","href":"/api-reference/uploaded-documents/list-documents"},{"title":"Retrieve document","openapi":"GET /v1/links/{link_id}/documents/{doc_id}/","href":"/api-reference/uploaded-documents/retrieve-document"}]},{"group":"Parsed Documents","pages":[{"title":"The Parsed Documents object","href":"/api-reference/parsed-documents/object"},{"title":"List all parsed documents","openapi":"GET /v1/links/{link_id}/parsed-documents/","href":"/api-reference/parsed-documents/list-parsed-documents"},{"title":"Retrieve parsed document","openapi":"GET /v1/links/{link_id}/parsed-documents/{doc_id}/","href":"/api-reference/parsed-documents/retrieve-parsed-document"}]}]},{"group":"Direct Deposit Switch","pages":[{"group":"Bank Accounts","pages":[{"title":"The Bank Accounts object","href":"/api-reference/bank-accounts/object"},{"title":"List all bank accounts","openapi":"GET /v1/links/{link_id}/bank_accounts/","href":"/api-reference/bank-accounts/link-bank-accounts"},{"title":"Bank Account Webhook Events","href":"/api-reference/bank-accounts/events"}]},{"group":"Deposit Switch","pages":[{"title":"The Deposit Switch object","href":"/api-reference/deposit-switch/object"},{"title":"Retrieve a direct deposit switch report for a link","openapi":"GET /v1/links/{link_id}/direct_deposit/report/","href":"/api-reference/deposit-switch/link_detail_reports_dds"},{"title":"Retrieve a paycheck linked loan report","openapi":"GET /v1/links/{link_id}/pll/report/","href":"/api-reference/deposit-switch/link_detail_reports_pll"}]},{"group":"User deposit switch report","pages":[{"title":"The User Deposit Switch Object","href":"/api-reference/dds-reports/object"},{"title":"Retrieve a deposit switch report","openapi":"GET /v1/users/{user_id}/deposit_switch/report/","href":"/api-reference/dds-reports/dds-report-retrieve"}]}]},{"group":"Insurance Verification","pages":[{"group":"Link Insurance Report","pages":[{"title":"The Insurance object","href":"/api-reference/insurance/object"},{"title":"Retrieve an auto insurance report","openapi":"GET /v1/links/{link_id}/insurance/report/auto/","href":"/api-reference/insurance/link_detail_reports_insurance_auto"},{"title":"Retrieve a home insurance report","openapi":"GET /v1/links/{link_id}/insurance/report/home/","href":"/api-reference/insurance/link_detail_reports_insurance_home"},{"title":"Retrieve an insurance report","openapi":"GET /v1/links/{link_id}/insurance/report/","href":"/api-reference/insurance/link_detail_reports_insurance"}]}]}]}]},"basePath":"","title":"Get order batch job status - Truv","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}