Attach a document to one of your cases, or to your creditor. Upload the file first with Upload file and pass the object it returns as file.
Set type to OTHER. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses.
Consider whether the debtor should be able to see the document. minAccessRole: "debtor" shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner.
Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}. API keys are issued and revoked directly from the creditor portal under Developers > API.
What the document is. The types other than OTHER carry legal meaning in the collection process — they decide whether the debt has a foundation and when it expires — and are set by the collector, not by you.
The uploaded file, as returned by the file endpoint. Only fileId is read: the name and content type are taken from the stored file, so they always agree with it.
The least privileged role that may see the document. debtor shows it to the debtor in the self-service portal, client to the creditor, caseworker only to the collector. Defaults to the collector-only level.
What the document is. The types other than OTHER carry legal meaning in the collection process — they decide whether the debt has a foundation and when it expires — and are set by the collector, not by you.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Debbie Creditor API Documentation","colors":{"primary":"#7568F6","light":"#07C983","dark":"#7865FF"},"logo":{"light":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/light.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=10910a8dfb5076aec86b09686383b541","dark":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/dark.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=a44edc79d1f69627d88b16d9a5157fb9"},"favicon":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/favicon.png?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=b296397199b185d9fb11859d70d6c74c","navbar":{"links":[{"href":"mailto:api-support@debbie.dk","label":"API Support"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/debbie"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"debbie-creditor-documentation","hasAudioNarration":false,"actualSubdomain":"debbie-creditor-documentation","customDomains":["creditor-documentation.debbiecollect.com"],"gitSource":{"type":"github","owner":"debbie-platform","repo":"debbie","deployBranch":"master","contentDirectory":"documentation/public-creditor-api","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af07e5a19e45f289c56f508","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"Using the API","count":6},{"language":"default","tag":"API Documentation","count":5},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Billings","count":2},{"language":"default","tag":"Files","count":2},{"language":"default","tag":"Case voucher allocations","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"rbac-expansion","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/documents/create","slug":"/api-reference/endpoints/documents/create","pageMetadata":{"title":"Add document","openapi":"POST /v1/{tenantId}/documents","description":"Attach a document to one of your cases, or to your creditor. Upload the file first with [Upload file](/api-reference/endpoints/files/create) and pass the object it returns as `file`.\n\nSet `type` to `OTHER`. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses.\n\nConsider whether the debtor should be able to see the document. `minAccessRole: \"debtor\"` shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner.\n\n**Required scope:** `write:documents`","href":"/api-reference/endpoints/documents/create"},"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 a: \"a\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Attach a document to one of your cases, or to your creditor. Upload the file first with \", _jsx(_components.a, {\n href: \"/api-reference/endpoints/files/create\",\n children: \"Upload file\"\n }), \" and pass the object it returns as \", _jsx(_components.code, {\n children: \"file\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Set \", _jsx(_components.code, {\n children: \"type\"\n }), \" to \", _jsx(_components.code, {\n children: \"OTHER\"\n }), \". The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Consider whether the debtor should be able to see the document. \", _jsx(_components.code, {\n children: \"minAccessRole: \\\"debtor\\\"\"\n }), \" shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"write:documents\"\n })]\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":"Add document","openapi":"POST /v1/{tenantId}/documents","description":"Attach a document to one of your cases, or to your creditor. Upload the file first with [Upload file](/api-reference/endpoints/files/create) and pass the object it returns as `file`.\n\nSet `type` to `OTHER`. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses.\n\nConsider whether the debtor should be able to see the document. `minAccessRole: \"debtor\"` shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner.\n\n**Required scope:** `write:documents`","href":"/api-reference/endpoints/documents/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Add document","description":"Attach a document to one of your cases, or to your creditor. Upload the file first with [Upload file](/api-reference/endpoints/files/create) and pass the object it returns as `file`.\n\nSet `type` to `OTHER`. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses.\n\nConsider whether the debtor should be able to see the document. `minAccessRole: \"debtor\"` shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner.\n\n**Required scope:** `write:documents`","operationId":"create-document","parameters":["6e5f2e1e-7819-4206-86fb-782c8a54bb7c","90eb506a-ada2-4646-9d4a-ae392a7ef2f7"],"requestBody":"9f66b397-5680-441c-9a44-9edf3eea1317","responses":{"200":"da8f2909-0c2c-4230-9ea1-ddfacdc3e85e","401":"7980b1b7-a143-49cc-91e1-76fad057aa2b","404":"e2b4e857-f1cb-4e1d-8134-7df572e95718","422":"89ec42c4-3d98-4989-8559-fe92c957e60c"},"method":"post","type":"path","servers":["cc6f2f36-b7d4-4509-a86c-ea66de6298f4"],"security":["af845bea-a179-4d12-a982-b17bced29b4d"],"path":"/v1/{tenantId}/documents","baseUrlOptions":["https://api.debbiecollect.com"],"title":"Add document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6e5f2e1e-7819-4206-86fb-782c8a54bb7c":{"in":"path","name":"tenantId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal."},"90eb506a-ada2-4646-9d4a-ae392a7ef2f7":{"in":"query","name":"creditorId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Your creditor id. You can find it on the API page in the creditor portal.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Your creditor id. You can find it on the API page in the creditor portal."}},"requestBody":{"description":"New document","content":{"application/json":{"schema":{"type":"object","properties":{"entityId":{"type":"string","format":"uuid","description":"Id of the case or the creditor the document belongs to.","isRequired":true,"uniqueKey":"entityId","typeLabel":"string\u003cuuid>"},"entityType":{"type":"string","enum":["case","creditor"],"description":"What the document is attached to. `case` hangs it on a collection case, `creditor` on the creditor itself.","isRequired":true,"uniqueKey":"entityType","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["OTHER","FOUNDATION","SKYLDERKLAERING","COURTOPGJORTOGFREMLAGT","DOM","PAATEGNING","FORLIG","COURT","GAELDSBREV"],"description":"What the document is. The types other than `OTHER` carry legal meaning in the collection process — they decide whether the debt has a foundation and when it expires — and are set by the collector, not by you.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"file":{"type":"object","properties":{"fileName":{"type":"string","isRequired":true,"uniqueKey":"file.fileName","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"file.contentType","typeLabel":"string"},"fileId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"file.fileId","typeLabel":"string\u003cuuid>"}},"required":["fileName","contentType","fileId"],"description":"The uploaded file, as returned by the file endpoint. Only fileId is read: the name and content type are taken from the stored file, so they always agree with it.","uniqueKey":"file","typeLabel":"object"},"minAccessRole":{"type":"string","enum":["debtor","client","caseworker"],"description":"The least privileged role that may see the document. `debtor` shows it to the debtor in the self-service portal, `client` to the creditor, `caseworker` only to the collector. Defaults to the collector-only level.","uniqueKey":"minAccessRole","typeLabel":"enum\u003cstring>"},"date":{"type":"string","description":"The date of the document itself, which can differ from the date it was uploaded. Defaults to now.","uniqueKey":"date","typeLabel":"string"},"isSigned":{"type":"boolean","description":"Whether the document is already signed.","uniqueKey":"isSigned","typeLabel":"boolean"},"signedAt":{"type":"string","description":"When the document was signed. Only used together with `isSigned`.","uniqueKey":"signedAt","typeLabel":"string"},"meta":{"type":"object","description":"Extra information about the document.","properties":{"note":{"type":"string","description":"A free-text note shown with the document.","uniqueKey":"meta.note","typeLabel":"string"},"amount":{"type":"integer","description":"Amount in the minor unit, used by document types that carry one.","uniqueKey":"meta.amount","typeLabel":"integer"}},"uniqueKey":"meta","typeLabel":"object"}},"required":["entityId","entityType","type"],"uniqueKey":"","typeLabel":"object"},"example":{"entityId":"3f1c2d4e-5a6b-7c8d-9e0f-1a2b3c4d5e6f","entityType":"case","type":"OTHER","minAccessRole":"debtor","file":{"fileId":"8d9f0c1e-2b3a-4c5d-6e7f-8a9b0c1d2e3f","fileName":"invoice-D12412347.pdf","contentType":"application/pdf"}},"examples":{"Example":{"title":"Example","value":{"entityId":"3f1c2d4e-5a6b-7c8d-9e0f-1a2b3c4d5e6f","entityType":"case","type":"OTHER","minAccessRole":"debtor","file":{"fileId":"8d9f0c1e-2b3a-4c5d-6e7f-8a9b0c1d2e3f","fileName":"invoice-D12412347.pdf","contentType":"application/pdf"}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"da8f2909-0c2c-4230-9ea1-ddfacdc3e85e":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","uniqueKey":"documentId","typeLabel":"string\u003cuuid>"},"id":{"type":"integer","description":"Sequential id of the document","uniqueKey":"id","typeLabel":"integer"},"tenantId":{"type":"string","format":"uuid","uniqueKey":"tenantId","typeLabel":"string\u003cuuid>"},"entityId":{"type":"string","format":"uuid","uniqueKey":"entityId","typeLabel":"string\u003cuuid>"},"entityType":{"type":"string","enum":["case","creditor"],"description":"What the document is attached to. `case` hangs it on a collection case, `creditor` on the creditor itself.","uniqueKey":"entityType","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["OTHER","FOUNDATION","SKYLDERKLAERING","COURTOPGJORTOGFREMLAGT","DOM","PAATEGNING","FORLIG","COURT","GAELDSBREV"],"description":"What the document is. The types other than `OTHER` carry legal meaning in the collection process — they decide whether the debt has a foundation and when it expires — and are set by the collector, not by you.","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"file":{"type":"object","properties":{"fileName":{"type":"string","isRequired":true,"uniqueKey":"file.fileName","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"file.contentType","typeLabel":"string"},"fileId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"file.fileId","typeLabel":"string\u003cuuid>"}},"required":["fileName","contentType","fileId"],"uniqueKey":"file","typeLabel":"object"},"signedFile":{"type":"object","properties":{"fileName":{"type":"string","isRequired":true,"uniqueKey":"signedFile.fileName","typeLabel":"string"},"contentType":{"type":"string","isRequired":true,"uniqueKey":"signedFile.contentType","typeLabel":"string"},"fileId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"signedFile.fileId","typeLabel":"string\u003cuuid>"}},"required":["fileName","contentType","fileId"],"description":"The signed version of the file, once the document has been signed.","uniqueKey":"signedFile","typeLabel":"object"},"minAccessRole":{"type":"string","uniqueKey":"minAccessRole","typeLabel":"string"},"date":{"type":"string","uniqueKey":"date","typeLabel":"string"},"signedAt":{"oneOf":[{"type":"string","uniqueKey":"signedAt.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"signedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"signedAt","typeLabel":"string | null"},"createdAt":{"type":"string","uniqueKey":"createdAt","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"documentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","id":123,"tenantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","entityId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","entityType":"case","type":"OTHER","file":{"fileName":"\u003cstring>","contentType":"\u003cstring>","fileId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"signedFile":{"fileName":"\u003cstring>","contentType":"\u003cstring>","fileId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"minAccessRole":"\u003cstring>","date":"\u003cstring>","signedAt":"\u003cstring>","createdAt":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7980b1b7-a143-49cc-91e1-76fad057aa2b":{"description":"Access token missing or invalid","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e2b4e857-f1cb-4e1d-8134-7df572e95718":{"description":"The requested resource was not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"89ec42c4-3d98-4989-8559-fe92c957e60c":{"description":"Unable to process the contained instructions.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"af845bea-a179-4d12-a982-b17bced29b4d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"cc6f2f36-b7d4-4509-a86c-ea66de6298f4":{"url":"https://api.debbiecollect.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"debbie-creditor-documentation","siteName":"Debbie Creditor API Documentation","title":"Add document - Debbie Creditor API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-09T19:16:43.837Z","originalFileLocation":"api-reference/endpoints/documents/create.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=\"Attach a document to one of your cases, or to your creditor. Upload the file first with Upload file and pass the object it returns as file. Set type to OTHER. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses. Consider whether the debtor should be able to see the document. minAccessRole: \u0026quot;debtor\u0026quot; shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner. Required scope: write:documents\">\u003cmeta data-mint-head name=\"application-name\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add document - Debbie Creditor API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Attach a document to one of your cases, or to your creditor. Upload the file first with Upload file and pass the object it returns as file. Set type to OTHER. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses. Consider whether the debtor should be able to see the document. minAccessRole: \u0026quot;debtor\u0026quot; shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner. Required scope: write:documents\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://debbie-creditor-documentation.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Add+document\u0026amp;description=Attach+a+document+to+one+of+your+cases%2C+or+to+your+creditor.+Upload+the+file+first+with+%5BUpload+file%5D%28%2Fapi-reference%2Fendpoints%2Ffiles%2Fcreate%29+and+pass+the+object\u0026amp;theme=6e81307c9eeccd10d2f7bdff\u0026amp;signature=404240788f448e3f0f2acce51cdd30005c31eb654a3558c2ffd01a16110efaa8\">\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=\"Add document - Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Attach a document to one of your cases, or to your creditor. Upload the file first with Upload file and pass the object it returns as file. Set type to OTHER. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses. Consider whether the debtor should be able to see the document. minAccessRole: \u0026quot;debtor\u0026quot; shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner. Required scope: write:documents\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://debbie-creditor-documentation.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Add+document\u0026amp;description=Attach+a+document+to+one+of+your+cases%2C+or+to+your+creditor.+Upload+the+file+first+with+%5BUpload+file%5D%28%2Fapi-reference%2Fendpoints%2Ffiles%2Fcreate%29+and+pass+the+object\u0026amp;theme=6e81307c9eeccd10d2f7bdff\u0026amp;signature=404240788f448e3f0f2acce51cdd30005c31eb654a3558c2ffd01a16110efaa8\">\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/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7568F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/documents/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\",\"name\":\"Debbie Creditor API Documentation\",\"url\":\"https://creditor-documentation.debbiecollect.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/light.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=10910a8dfb5076aec86b09686383b541\"}},{\"@type\":\"WebSite\",\"@id\":\"https://creditor-documentation.debbiecollect.com#website\",\"name\":\"Debbie Creditor API Documentation\",\"url\":\"https://creditor-documentation.debbiecollect.com\",\"publisher\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create#webpage\",\"url\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create\",\"name\":\"Add document\",\"description\":\"Attach a document to one of your cases, or to your creditor. Upload the file first with Upload file and pass the object it returns as file. Set type to OTHER. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses. Consider whether the debtor should be able to see the document. minAccessRole: \\\"debtor\\\" shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner. Required scope: write:documents\",\"dateModified\":\"2026-09-09T19:16:43.837Z\",\"isPartOf\":{\"@id\":\"https://creditor-documentation.debbiecollect.com#website\"},\"breadcrumb\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Debbie Creditor API Documentation\",\"item\":\"https://creditor-documentation.debbiecollect.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add document\",\"item\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create#apireference\",\"headline\":\"Add document\",\"name\":\"Add document\",\"description\":\"Attach a document to one of your cases, or to your creditor. Upload the file first with Upload file and pass the object it returns as file. Set type to OTHER. The other document types decide whether a debt has a legal foundation and when it expires, and are set by your debt collection partner as the case progresses. Consider whether the debtor should be able to see the document. minAccessRole: \\\"debtor\\\" shows it in the debtor self-service portal, which is what you want for an invoice copy, a contract or a photo that documents the claim. Leave it out to keep the document between you and your debt collection partner. Required scope: write:documents\",\"url\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create\",\"mainEntityOfPage\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/documents/create#webpage\"},\"dateModified\":\"2026-09-09T19:16:43.837Z\",\"publisher\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\"},\"isPartOf\":{\"@id\":\"https://creditor-documentation.debbiecollect.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Debbie Creditor API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Debbie Creditor API Documentation","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"tabs":[{"tab":"Using the API","pages":[{"title":"Using the API","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Voucher types","href":"/api-reference/voucher-types"}]},{"group":"Customers","pages":[{"title":"Create customer","openapi":"POST /v1/{tenantId}/customers","href":"/api-reference/endpoints/customers/create"},{"title":"Get customer by id","openapi":"GET /v1/{tenantId}/customers/{customerId}","href":"/api-reference/endpoints/customers/get"},{"title":"Get customer by reference id","openapi":"GET /v1/{tenantId}/customers/by-reference-id/{referenceId}","href":"/api-reference/endpoints/customers/get-by-reference"},{"title":"Add case vouchers","openapi":"POST /v1/{tenantId}/customers/{customerId}/add-case-vouchers","href":"/api-reference/endpoints/customers/add-case-vouchers"}]},{"group":"Case voucher allocations","pages":[{"title":"Register case voucher allocation","openapi":"POST /v1/{tenantId}/case-vouchers/allocations","href":"/api-reference/endpoints/case-vouchers/allocations"}]},{"group":"Files","pages":[{"title":"Upload file","openapi":"POST /v1/{tenantId}/files","href":"/api-reference/endpoints/files/create"},{"title":"Get file","openapi":"GET /v1/{tenantId}/files/{fileId}/{fileName}","description":"Download a file by file id.\n\n**Required scope:** `read:files`\n\n\u003cWarning>`read:files` is not currently among the scopes a creditor API key can be issued with, so this endpoint cannot be called with a creditor key. Files you upload are referenced by id on case vouchers and do not need to be read back.\u003c/Warning>","href":"/api-reference/endpoints/files/get"}]},{"group":"Documents","pages":[{"title":"Add document","openapi":"POST /v1/{tenantId}/documents","href":"/api-reference/endpoints/documents/create"}]},{"group":"Voucher types","pages":[{"title":"Get voucher types","openapi":"GET /v1/{tenantId}/voucher-types","description":"Get the voucher types available on your debt collection partner, sorted by their order. Fetch the list once and cache it rather than hard-coding the ids — it also covers the types your partner has defined themselves, which are not on the [Voucher types](/api-reference/voucher-types) page.\n\n**Required scope:** `read:voucher-types`","href":"/api-reference/endpoints/voucher-types/get"}]},{"group":"Billings","pages":[{"title":"Get deposit distribution","openapi":"GET /v1/{tenantId}/billings/{billingId}/deposit-distribution","href":"/api-reference/endpoints/billings/deposit-distribution"},{"title":"Get billing vouchers","openapi":"GET /v1/{tenantId}/billings/{billingId}/billing-vouchers","href":"/api-reference/endpoints/billings/billing-vouchers"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/introduction"},{"title":"Create webhook","openapi":"POST /v1/{tenantId}/webhooks","href":"/api-reference/endpoints/webhooks/create"},{"title":"Get webhooks","openapi":"GET /v1/{tenantId}/webhooks","href":"/api-reference/endpoints/webhooks/get-list"},{"title":"Get webhook","openapi":"GET /v1/{tenantId}/webhooks/{webhookId}","href":"/api-reference/endpoints/webhooks/get"},{"title":"Delete webhook","openapi":"DELETE /v1/{tenantId}/webhooks/{webhookId}","href":"/api-reference/endpoints/webhooks/delete"},{"title":"Get webhook items","openapi":"GET /v1/{tenantId}/webhooks/items","href":"/api-reference/endpoints/webhooks/get-items"},{"title":"Patch webhook item","openapi":"PATCH /v1/{tenantId}/webhooks/items/{itemId}","href":"/api-reference/endpoints/webhooks/patch-item"},{"title":"Case created","openapi":"webhook cases.create","href":"/api-reference/webhooks/cases.create"},{"title":"Case updated","openapi":"webhook cases.update","href":"/api-reference/webhooks/cases.update"},{"title":"Case deleted","openapi":"webhook cases.delete","href":"/api-reference/webhooks/cases.delete"},{"title":"Billing created","openapi":"webhook billings.create","href":"/api-reference/webhooks/billings.create"}]}]}]},"basePath":"","title":"Add document - Debbie Creditor API Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}