Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Slate","colors":{"primary":"#000000","light":"#192f3f","dark":"#84949b"},"logo":{"light":"https://media.brand.dev/6f0cc793-20dd-41a8-9779-acf1a70c5577.png","dark":"https://media.brand.dev/6f0cc793-20dd-41a8-9779-acf1a70c5577.png"},"favicon":"https://media.brand.dev/2d71703b-6793-4a65-9d01-262e367101ae.png","navbar":{"primary":{"type":"button","label":"Request a Demo","href":"https://slate.inc"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"slate-systems","hasAudioNarration":false,"actualSubdomain":"slate-systems","customDomains":["docs.slate.inc"],"gitSource":{"type":"github","owner":"slateinc","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae90af82e4f13076948691e","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Files \u0026 Requests","count":20},{"language":"default","tag":"Quality Control","count":16},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Signatures","count":11},{"language":"default","tag":"Accounts","count":9},{"language":"default","tag":"Creditors \u0026 Firms","count":8},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Users","count":5},{"language":"default","tag":"Redactions","count":5}]},"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/add-external-refs-to-a-creditor","slug":"/api-reference/add-external-refs-to-a-creditor","pageMetadata":{"title":"Add external refs to a creditor","description":"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/creditors/{creditorId}/externalRefs","href":"/api-reference/add-external-refs-to-a-creditor","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.\"\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 external refs to a creditor","description":"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/creditors/{creditorId}/externalRefs","href":"/api-reference/add-external-refs-to-a-creditor","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"addCreditorExternalRefs","summary":"Add external refs to a creditor","description":"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.","requestBody":"4fed9558-5a26-46ec-a8fe-4f10830c5051","responses":{"200":"44ca3a3e-94f5-4e32-ad87-e53ffb5961ba","400":"18943ab5-5eb7-477f-832d-144060fa3d4e","401":"b9068ddc-b8ae-48cf-ae74-429fe325a3ae","404":"5b11c47d-a38b-4625-929f-2bc5a865802c","500":"b7ccde48-7d61-4171-a3f3-1533bc46f5d7"},"method":"post","type":"path","servers":["4f9a47e2-90d3-475e-bcdc-4f24b6200833","d47323f7-48f3-4929-b86f-dd32501fe232"],"security":["74cb74b6-29ea-4f98-8999-1c0d992ba52e"],"path":"/v1/creditors/{creditorId}/externalRefs","baseUrlOptions":["https://api.slate.inc/accounts","https://api.uat.slate.inc/accounts"],"title":"Add external refs to a creditor","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"968bc25e-25f0-4ed0-8fb7-8fdff34ca7dd":{"name":"creditorId","in":"path","required":true,"description":"Slate's UUID for the creditor (returned by create). The canonical creditor identifier.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Slate's UUID for the creditor (returned by create). The canonical creditor identifier.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["externalRefs"],"properties":{"externalRefs":{"type":"array","items":{"type":"string","uniqueKey":"externalRefs.items.[INDEX]","typeLabel":"string"},"description":"Partner codes to register to this entity (case-insensitive). Idempotent; a code already registered is re-pointed to this entity.","isRequired":true,"uniqueKey":"externalRefs","typeLabel":"string[]"},"owner":{"type":"string","description":"Tenant owner for machine-to-machine requests. Single-owner tokens infer it from the token.","uniqueKey":"owner","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalRefs":["\u003cstring>"],"owner":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"44ca3a3e-94f5-4e32-ad87-e53ffb5961ba":{"description":"The updated creditor.","content":{"application/json":{"schema":{"type":"object","description":"A creditor managed by an owner. Accounts reference it by `creditorId`.","required":["creditorId","owner","name"],"properties":{"creditorId":{"type":"string","format":"uuid","readOnly":true,"description":"Slate's stable UUID for the creditor — the canonical identifier, assigned by Slate on create.","isRequired":true,"uniqueKey":"creditorId","typeLabel":"string\u003cuuid>"},"owner":{"type":"string","description":"The organization that manages this creditor.","isRequired":true,"uniqueKey":"owner","typeLabel":"string"},"name":{"type":"string","description":"Human-readable creditor name.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"externalRefs":{"type":"array","readOnly":true,"items":{"type":"string","uniqueKey":"externalRefs.items.[INDEX]","typeLabel":"string"},"description":"Partner codes currently registered to this creditor, lower-cased and sorted.","uniqueKey":"externalRefs","typeLabel":"string[]"},"metadata":{"type":"object","description":"Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"example":{"region":"west","portfolio_tier":"gold"},"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"creditorId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","owner":"\u003cstring>","name":"\u003cstring>","externalRefs":["\u003cstring>"],"metadata":{"region":"west","portfolio_tier":"gold"}}}},"exampleType":"generated"}},"exampleType":"generated"},"18943ab5-5eb7-477f-832d-144060fa3d4e":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b9068ddc-b8ae-48cf-ae74-429fe325a3ae":{"description":"Missing, invalid, or insufficiently scoped credentials.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5b11c47d-a38b-4625-929f-2bc5a865802c":{"description":"The requested resource does not exist or is not visible to your owner.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b7ccde48-7d61-4171-a3f3-1533bc46f5d7":{"description":"Unexpected internal error.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable description of what went wrong.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"74cb74b6-29ea-4f98-8999-1c0d992ba52e":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Owner-scoped bearer token. The `owner` all requests are scoped to is derived from the token.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4f9a47e2-90d3-475e-bcdc-4f24b6200833":{"url":"https://api.slate.inc/accounts","description":"Production"},"d47323f7-48f3-4929-b86f-dd32501fe232":{"url":"https://api.uat.slate.inc/accounts","description":"UAT (staging)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Owner-scoped bearer token. The `owner` all requests are scoped to is derived from the token.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Owner-scoped bearer token. The `owner` all requests are scoped to is derived from the token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/accounts/openapi.yaml"},"subdomain":"slate-systems","siteName":"Slate","title":"Add external refs to a creditor - Slate","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T19:40:17.476Z","originalFileLocation":"api-reference/add-external-refs-to-a-creditor.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=\"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Slate\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://media.brand.dev/2d71703b-6793-4a65-9d01-262e367101ae.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://media.brand.dev/2d71703b-6793-4a65-9d01-262e367101ae.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://media.brand.dev/2d71703b-6793-4a65-9d01-262e367101ae.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://media.brand.dev/2d71703b-6793-4a65-9d01-262e367101ae.png\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add external refs to a creditor - Slate\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Slate\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://slate-systems.mintlify.site/_mintlify/api/og/v2?division=Creditors+%26+Firms\u0026amp;title=Add+external+refs+to+a+creditor\u0026amp;description=Registers+partner+codes+that+resolve+to+this+creditor+for+your+owner.+Idempotent%3B+a+code+already+registered+is+re-pointed+to+this+creditor.\u0026amp;theme=f55758e8481defec48951dd2\u0026amp;signature=3f0552b8b5a8701324b2cddc81cc15d1cc80842fa199cba5cffeed82333c93a6\">\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 external refs to a creditor - Slate\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://slate-systems.mintlify.site/_mintlify/api/og/v2?division=Creditors+%26+Firms\u0026amp;title=Add+external+refs+to+a+creditor\u0026amp;description=Registers+partner+codes+that+resolve+to+this+creditor+for+your+owner.+Idempotent%3B+a+code+already+registered+is+re-pointed+to+this+creditor.\u0026amp;theme=f55758e8481defec48951dd2\u0026amp;signature=3f0552b8b5a8701324b2cddc81cc15d1cc80842fa199cba5cffeed82333c93a6\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/slate-systems/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Slate\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/add-external-refs-to-a-creditor.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.slate.inc/#organization\",\"name\":\"Slate\",\"url\":\"https://docs.slate.inc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://media.brand.dev/6f0cc793-20dd-41a8-9779-acf1a70c5577.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.slate.inc#website\",\"name\":\"Slate\",\"url\":\"https://docs.slate.inc\",\"publisher\":{\"@id\":\"https://docs.slate.inc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor#webpage\",\"url\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor\",\"name\":\"Add external refs to a creditor\",\"description\":\"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.\",\"dateModified\":\"2026-10-23T19:40:17.476Z\",\"isPartOf\":{\"@id\":\"https://docs.slate.inc#website\"},\"breadcrumb\":{\"@id\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Creditors \u0026 Firms\",\"item\":\"https://docs.slate.inc/api-reference/list-creditors\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add external refs to a creditor\",\"item\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor#apireference\",\"headline\":\"Add external refs to a creditor\",\"name\":\"Add external refs to a creditor\",\"description\":\"Registers partner codes that resolve to this creditor for your owner. Idempotent; a code already registered is re-pointed to this creditor.\",\"url\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor\",\"mainEntityOfPage\":{\"@id\":\"https://docs.slate.inc/api-reference/add-external-refs-to-a-creditor#webpage\"},\"dateModified\":\"2026-10-23T19:40:17.476Z\",\"publisher\":{\"@id\":\"https://docs.slate.inc/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.slate.inc#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Slate\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Slate","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"tab":"API Reference","groups":[{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"sidebarTitle":"List accounts","openapi":"/api-reference/accounts/openapi.yaml get /v1/accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create or update an account (upsert)","deprecated":null,"version":null,"sidebarTitle":"Upsert account","openapi":"/api-reference/accounts/openapi.yaml post /v1/accounts","href":"/api-reference/accounts/upsert-account"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/accounts/{accountId}","href":"/api-reference/get-an-account"},{"title":"Update an account","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml patch /v1/accounts/{accountId}","href":"/api-reference/update-an-account"},{"title":"List entities on an account","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/accounts/{accountId}/entities","href":"/api-reference/list-entities-on-an-account"},{"title":"Create a entity on an account","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/accounts/{accountId}/entities","href":"/api-reference/create-a-entity-on-an-account"},{"title":"Get a entity","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/accounts/{accountId}/entities/{entityId}","href":"/api-reference/get-a-entity"},{"title":"Update a entity","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml patch /v1/accounts/{accountId}/entities/{entityId}","href":"/api-reference/update-a-entity"},{"title":"Deactivate a entity","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml delete /v1/accounts/{accountId}/entities/{entityId}","href":"/api-reference/deactivate-a-entity"}]},{"group":"Creditors \u0026 Firms","pages":[{"title":"List creditors","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/creditors","href":"/api-reference/list-creditors"},{"title":"Create a creditor","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/creditors","href":"/api-reference/create-a-creditor"},{"title":"Get a creditor","description":"Returns a creditor managed by the caller's owner, by its Slate `creditorId`.","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/creditors/{creditorId}","href":"/api-reference/get-a-creditor"},{"title":"Add external refs to a creditor","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/creditors/{creditorId}/externalRefs","href":"/api-reference/add-external-refs-to-a-creditor"},{"title":"List firms","description":"Returns the service firms managed by the caller's owner. Filter by `externalRef` to resolve a partner code to its firm.","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/firms","href":"/api-reference/list-firms"},{"title":"Create a firm","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/firms","href":"/api-reference/create-a-firm"},{"title":"Get a firm","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml get /v1/firms/{firmId}","href":"/api-reference/get-a-firm"},{"title":"Add external refs to a firm","deprecated":null,"version":null,"openapi":"/api-reference/accounts/openapi.yaml post /v1/firms/{firmId}/externalRefs","href":"/api-reference/add-external-refs-to-a-firm"}]},{"group":"Files \u0026 Requests","pages":[{"title":"List requests","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v1/requests","href":"/api-reference/requests/list-requests"},{"title":"Create a request","deprecated":null,"version":null,"sidebarTitle":"Create request","openapi":"/api-reference/files/openapi.yaml post /v1/requests","href":"/api-reference/files/create-request"},{"title":"Get a request","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v1/requests/{requestId}","href":"/api-reference/requests/get-a-request"},{"title":"Update a request","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml patch /v1/requests/{requestId}","href":"/api-reference/requests/update-a-request"},{"title":"Delete a request","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml delete /v1/requests/{requestId}","href":"/api-reference/requests/delete-a-request"},{"title":"Add an exhibit","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/requests/{requestId}/exhibits","href":"/api-reference/exhibits/add-an-exhibit"},{"title":"Update an exhibit","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml patch /v1/requests/{requestId}/exhibits/{exhibitId}","href":"/api-reference/exhibits/update-an-exhibit"},{"title":"Delete an exhibit","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml delete /v1/requests/{requestId}/exhibits/{exhibitId}","href":"/api-reference/exhibits/delete-an-exhibit"},{"title":"Update a template on a request","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml patch /v1/requests/{requestId}/templates/{templateIdTemplateIndex}","href":"/api-reference/requests/update-a-template-on-a-request"},{"title":"Delete a template from a request","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml delete /v1/requests/{requestId}/templates/{templateIdTemplateIndex}","href":"/api-reference/requests/delete-a-template-from-a-request"},{"title":"Generate a PDF from a template","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/requests/{requestId}/templates/{templateIdTemplateIndex}/generate","href":"/api-reference/requests/generate-a-pdf-from-a-template"},{"title":"Generate a PDF from a request","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/requests/{requestId}/generate","href":"/api-reference/requests/generate-a-pdf-from-a-request"},{"title":"Approve a request and finalize its PDF","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/requests/{requestId}/approve","href":"/api-reference/requests/approve-a-request-and-finalize-its-pdf"},{"title":"List files","deprecated":null,"version":null,"sidebarTitle":"List files","openapi":"/api-reference/files/openapi.yaml get /v2/files","href":"/api-reference/files/list-files"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v2/files/{fileId}","href":"/api-reference/files/get-a-file"},{"title":"Create a file upload session","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/files","href":"/api-reference/files/create-a-file-upload-session"},{"title":"Concatenate files into a single PDF","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/files/concat","href":"/api-reference/files/concatenate-files-into-a-single-pdf"},{"title":"Archive a file","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml delete /v1/files/{fileId}","href":"/api-reference/files/archive-a-file"},{"title":"Request a bulk file download","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/bulkDownloads","href":"/api-reference/bulk-downloads/request-a-bulk-file-download"},{"title":"Get bulk download job status","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /files/bulkDownloads/{bulkDownloadId}","href":"/api-reference/bulk-downloads/get-bulk-download-job-status"}]},{"group":"Redactions","pages":[{"title":"List redaction jobs","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v1/redactions","href":"/api-reference/redactions/list-redaction-jobs"},{"title":"Submit a redaction job","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml post /v1/redactions","href":"/api-reference/redactions/submit-a-redaction-job"},{"title":"Get a redaction job","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v1/redactions/{redactionId}","href":"/api-reference/redactions/get-a-redaction-job"},{"title":"Get redaction job status","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v1/redactions/{redactionId}/status","href":"/api-reference/redactions/get-redaction-job-status"},{"title":"Get a download URL for the redacted PDF","deprecated":null,"version":null,"openapi":"/api-reference/files/openapi.yaml get /v1/redactions/{redactionId}/file","href":"/api-reference/redactions/get-a-download-url-for-the-redacted-pdf"}]},{"group":"Signatures","pages":[{"title":"List signature requests","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml get /v2/requests","href":"/api-reference/list-signature-requests"},{"title":"Create a signature request","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml post /v2/requests","href":"/api-reference/create-a-signature-request"},{"title":"Get a signature request","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml get /v2/requests/{signatureRequestId}","href":"/api-reference/get-a-signature-request"},{"title":"Update a signature request","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml patch /v2/requests/{signatureRequestId}","href":"/api-reference/update-a-signature-request"},{"title":"Delete a signature request","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml delete /v2/requests/{signatureRequestId}","href":"/api-reference/delete-a-signature-request"},{"title":"Get an upload URL for a signed wet-ink scan","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml get /v2/requests/{signatureRequestId}/uploadUrl","href":"/api-reference/get-an-upload-url-for-a-signed-wet-ink-scan"},{"title":"List signature transactions","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml get /v2/transactions","href":"/api-reference/list-signature-transactions"},{"title":"Create a signature transaction","deprecated":null,"version":null,"sidebarTitle":"Create transaction","openapi":"/api-reference/signatures/openapi.yaml post /v2/transactions","href":"/api-reference/signatures/create-transaction"},{"title":"Get a signature transaction","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml get /v2/transactions/{signatureTransactionId}","href":"/api-reference/get-a-signature-transaction"},{"title":"Update a signature transaction","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml patch /v2/transactions/{signatureTransactionId}","href":"/api-reference/update-a-signature-transaction"},{"title":"Get a signing URL for a signature transaction","deprecated":null,"version":null,"openapi":"/api-reference/signatures/openapi.yaml get /v2/transactions/{signatureTransactionId}/signingUrl","href":"/api-reference/get-a-signing-url-for-a-signature-transaction"}]},{"group":"Quality Control","pages":[{"title":"List all QC checklists","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml get /v2/qc/checklists","href":"/api-reference/list-all-qc-checklists"},{"title":"Create a new checklist with items","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml post /v2/qc/checklists","href":"/api-reference/create-a-new-checklist-with-items"},{"title":"Get a QC checklist and items","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml get /v2/qc/checklists/{qclID}","href":"/api-reference/get-a-qc-checklist-and-items"},{"title":"Update a QC Checklist and items","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml patch /v2/qc/checklists/{qclID}","href":"/api-reference/update-a-qc-checklist-and-items"},{"title":"Create a QC checklist group","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml post /v2/qc/checklists/{qclID}/groups","href":"/api-reference/create-a-qc-checklist-group"},{"title":"List all QC requests","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml get /v2/qc/requests","href":"/api-reference/list-all-qc-requests"},{"title":"Create a one-off QC request","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml post /v2/qc/requests","href":"/api-reference/create-a-one-off-qc-request"},{"title":"Get a QC Request","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml get /v2/qc/requests/{qcrID}","href":"/api-reference/get-a-qc-request"},{"title":"Update a QC Request","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml patch /v2/qc/requests/{qcrID}","href":"/api-reference/update-a-qc-request"},{"title":"Discard a QC Request review","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml delete /v2/qc/requests/{qcrID}","href":"/api-reference/discard-a-qc-request-review"},{"title":"Update a QC Request checklist item","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml patch /v2/qc/requests/{qcrID}/items/{itemID}","href":"/api-reference/update-a-qc-request-checklist-item"},{"title":"Undo a QC Request review","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml post /v2/qc/requests/{qcrID}/undo","href":"/api-reference/undo-a-qc-request-review"},{"title":"List all QC requests and checklists for reporting","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml get /v2/qc/feedback","href":"/api-reference/list-all-qc-requests-and-checklists-for-reporting"},{"title":"List QC processes","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml get /v2/qc/processes","href":"/api-reference/list-qc-processes"},{"title":"Create a new process","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml post /v2/qc/processes","href":"/api-reference/create-a-new-process"},{"title":"Update a QC Process","deprecated":null,"version":null,"openapi":"/api-reference/qc/openapi.yaml patch /v2/qc/processes/{qcpID}","href":"/api-reference/update-a-qc-process"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"sidebarTitle":"List users","openapi":"/api-reference/users/openapi.yaml get /v1/users","href":"/api-reference/users/list-users"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/users/openapi.yaml get /v1/users/{userId}","href":"/api-reference/get-a-user"},{"title":"Create or update a user","deprecated":null,"version":null,"openapi":"/api-reference/users/openapi.yaml put /v1/users/{userId}","href":"/api-reference/create-or-update-a-user"},{"title":"Update a user's activation state","deprecated":null,"version":null,"openapi":"/api-reference/users/openapi.yaml patch /v1/users/{userId}","href":"/api-reference/update-a-users-activation-state"},{"title":"Request an image upload URL","deprecated":null,"version":null,"openapi":"/api-reference/users/openapi.yaml post /v1/users/{userId}/images","href":"/api-reference/request-an-image-upload-url"}]}]}]},"basePath":"","title":"Add external refs to a creditor - Slate","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"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","Page-C945cI-W.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","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"]}