Whether this entity is a favorite of the authenticated user in their organization. Included by default on GET entity list and item responses only; when selecting response fields with properties[], include properties[]=isFavorite to receive it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Syntage","colors":{"primary":"#1975FF","light":"#1975FF"},"logo":{"light":"https://mintcdn.com/syntage/NuYQc9gEjSxFZJMz/logo.svg?fit=max\u0026auto=format\u0026n=NuYQc9gEjSxFZJMz\u0026q=85\u0026s=976345a01e03638f59ea0f9cb2a7d8d3","dark":"https://mintcdn.com/syntage/Guui-PNq2RqcZDxJ/logo-dark.svg?fit=max\u0026auto=format\u0026n=Guui-PNq2RqcZDxJ\u0026q=85\u0026s=fb29ea6c7437fb18ca359ce2c22460f9"},"favicon":"https://mintcdn.com/syntage/UtiP7paDbtCUc-2P/favicon.ico?fit=max\u0026auto=format\u0026n=UtiP7paDbtCUc-2P\u0026q=85\u0026s=37b2c70e584adf9b64dedef8bd5fbabb","api":{"mdx":{"auth":{"method":"key","name":"x-api-key"},"server":"https://api.syntage.com"}},"navbar":{"links":[{"href":"https://support.syntage.com","label":"Support"}],"primary":{"type":"button","label":"Go to App","href":"https://app.syntage.com"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","aistudio","mcp","add-mcp","cursor","vscode","devin-mcp","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"syntage","hasAudioNarration":false,"actualSubdomain":"syntage","customDomains":["docs.syntage.com"],"gitSource":{"type":"github","owner":"syntagecom","repo":"platform.backend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae90116d9c69230b286253d","collectionId":"ffbb75e2-6f1e-432d-8781-51c264392b3e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae90116d9c69230b286253d"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae90116d9c69230b286253d","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"en","tag":"API Reference","count":178},{"language":"en","tag":"Datasource: SAT","count":47},{"language":"en","tag":"Core Resources","count":42},{"language":"en","tag":"Resource Guide","count":40},{"language":"es","tag":"Guía de recursos","count":40},{"language":"en","tag":"Insights","count":32},{"language":"en","tag":"Invoices","count":32},{"language":"en","tag":"Datasources","count":28},{"language":"es","tag":"Fuentes de datos","count":28},{"language":"en","tag":"Other Resources","count":23},{"language":"en","tag":"Using Syntage","count":21},{"language":"es","tag":"Usar Syntage","count":21},{"language":"en","tag":"Entities","count":18},{"language":"es","tag":"SAT","count":14},{"language":"es","tag":"Dashboard","count":8},{"language":"es","tag":"Recursos principales","count":6},{"language":"es","tag":"Facturas","count":6},{"language":"es","tag":"Desarrolladores","count":5},{"language":"es","tag":"Comienza aquí","count":5},{"language":"es","tag":"Cómo funciona Syntage","count":5}]},"assistantConfig":{},"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":[],"page":{"pagePath":"api-reference/entities/retrieve-an-entity","slug":"/api-reference/entities/retrieve-an-entity","pageMetadata":{"openapi":"get /entities/{entityId}","title":"Retrieve an Entity","description":"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.","href":"/api-reference/entities/retrieve-an-entity"},"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: \"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.\"\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":{"openapi":"get /entities/{entityId}","title":"Retrieve an Entity","description":"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.","href":"/api-reference/entities/retrieve-an-entity"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Entities"],"operationId":"GetEntity","summary":"Retrieve an Entity","description":"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.","parameters":["b8b59bb5-6efa-4d3e-8f18-9ed64c4cc73e"],"responses":{"200":"144f6409-2555-421d-b813-892bc1d05083","401":"a8aa59c9-36c3-46cc-a6cf-742e7abf972e","404":"af7a65ee-1181-46f1-9026-a746a10dbc11"},"method":"get","type":"path","servers":["c0c00d4e-7bf0-4fcd-989c-f0e3cfa4f7dc","e5007030-8e8d-4029-845f-889b1bebb7c0"],"security":["fcbdb868-b868-40c3-b318-960822ff0a94"],"path":"/entities/{entityId}","baseUrlOptions":["https://api.syntage.com","https://api.sandbox.syntage.com"],"title":"Retrieve an Entity","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b8b59bb5-6efa-4d3e-8f18-9ed64c4cc73e":{"name":"entityId","in":"path","required":true,"example":"91106968-1abd-4d64-85c1-4e73d96fb997","schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"144f6409-2555-421d-b813-892bc1d05083":{"description":"Entity resource response","content":{"application/ld+json":{"schema":{"type":"object","properties":{"@context":{"type":"string","default":"/contexts/Entity","uniqueKey":"@context","typeLabel":"string"},"@id":{"type":"string","format":"iri-reference","description":"Entity IRI reference","example":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","description":"JSON-LD resource type; Entity resources currently use the legacy `Link` JSON-LD type for backwards compatibility","default":"Link","uniqueKey":"@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","example":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["company","person"],"description":"Type of entity","example":"company","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"taxpayer":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference","description":"Taxpayer IRI reference","example":"/taxpayers/PEIC211118IS0","uniqueKey":"taxpayer.@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","default":"Taxpayer","uniqueKey":"taxpayer.@type","typeLabel":"string"},"id":{"type":"string","minLength":12,"maxLength":13,"description":"RFC (Registro Federal de Contribuyentes)","example":"PEIC211118IS0","uniqueKey":"taxpayer.id","typeLabel":"string"},"personType":{"type":"string","enum":["physical","legal"],"example":"physical","uniqueKey":"taxpayer.personType","typeLabel":"enum\u003cstring>"},"registrationDate":{"type":"string","format":"date","description":"Taxpayer registration date","uniqueKey":"taxpayer.registrationDate","typeLabel":"string\u003cdate>"},"name":{"type":"string","minLength":1,"maxLength":254,"description":"Taxpayer name","example":"Pedro Infante Cruz","uniqueKey":"taxpayer.name","typeLabel":"string"}},"uniqueKey":"taxpayer","typeLabel":"object"},"credential":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference","description":"SAT Credential IRI reference","example":"/credentials/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"credential.@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","default":"Credential","uniqueKey":"credential.@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","description":"Credential ID","example":"91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"credential.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["ciec","efirma"],"example":"ciec","uniqueKey":"credential.type","typeLabel":"enum\u003cstring>"},"rfc":{"type":"string","minLength":12,"maxLength":13,"description":"RFC (Registro Federal de Contribuyentes)","example":"PEIC211118IS0","uniqueKey":"credential.rfc","typeLabel":"string"},"status":{"type":"string","enum":["waiting","pending","valid","invalid","disabled","deactivated","error"],"x-enumDeprecated":{"deactivated":"Legacy status retained for existing records. The `disabled` status is used for credentials that can no longer be used."},"description":"Credential validation status:\n\n| Value | Description |\n| --- | --- |\n| `waiting` | Credential validation is temporarily disabled, usually because of an ongoing incident. The credential will be validated later. |\n| `pending` | Credential validation has been requested and is waiting to be processed. |\n| `valid` | The credential was accepted by SAT and can be used for extractions. |\n| `invalid` | SAT rejected the credential during validation. |\n| `disabled` | SAT reported the credential as disabled or otherwise unrecoverable during validation. |\n| `deactivated` | **Deprecated.** Legacy status retained for existing records. The `disabled` status is used for credentials that can no longer be used. |\n| `error` | Credential validation failed because of an unexpected error. |\n","example":"pending","uniqueKey":"credential.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"credential.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"credential.updatedAt","typeLabel":"string"}},"uniqueKey":"credential","typeLabel":"object"},"tags":{"type":"array","items":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference","description":"Entity Tag IRI reference","example":"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997","uniqueKey":"tags.items.[INDEX].@id","typeLabel":"string\u003ciri-reference>"},"@type":{"type":"string","description":"JSON-LD resource type","default":"EntityTag","uniqueKey":"tags.items.[INDEX].@type","typeLabel":"string"},"id":{"type":"string","format":"uuid","example":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","uniqueKey":"tags.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Display name for the entity tag","example":"Priority Entity","nullable":false,"uniqueKey":"tags.items.[INDEX].name","typeLabel":"string"},"color":{"oneOf":[{"type":"string","description":"Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when an entity tag is created without a color.","example":"#22c558","uniqueKey":"tags.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Lowercase 7-character hexadecimal color used to display the tag (`#RRGGBB`). Defaults to `#a3aab5` when an entity tag is created without a color.","example":"#22c558","uniqueKey":"tags.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags.items.[INDEX].color","typeLabel":"string | null"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"tags.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"tags.items.[INDEX].updatedAt","typeLabel":"string"}},"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tags","typeLabel":"object[]"},"isFavorite":{"type":"boolean","readOnly":true,"description":"Whether this entity is a favorite of the authenticated user in their organization. Included by default on GET entity list and item responses only; when selecting response fields with properties[], include properties[]=isFavorite to receive it.","uniqueKey":"isFavorite","typeLabel":"boolean"},"createdAt":{"type":"string","description":"Date and time the resource was created","example":"2020-01-01T12:15:00.000Z","uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Date and time the resource was last updated","example":"2020-01-01T12:15:00.000Z","uniqueKey":"updatedAt","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"@context":"/contexts/Entity","@id":"/entities/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"Link","id":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","type":"company","taxpayer":{"@id":"/taxpayers/PEIC211118IS0","@type":"Taxpayer","id":"PEIC211118IS0","personType":"physical","registrationDate":"2023-12-25","name":"Pedro Infante Cruz"},"credential":{"@id":"/credentials/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"Credential","id":"91106968-1abd-4d64-85c1-4e73d96fb997","type":"ciec","rfc":"PEIC211118IS0","status":"pending","createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"},"tags":[{"@id":"/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997","@type":"EntityTag","id":"e0a24894-7fbf-48ae-bfb0-efaae30a6319","name":"Priority Entity","color":"#22c558","createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"}],"isFavorite":true,"createdAt":"2020-01-01T12:15:00.000Z","updatedAt":"2020-01-01T12:15:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"a8aa59c9-36c3-46cc-a6cf-742e7abf972e":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"af7a65ee-1181-46f1-9026-a746a10dbc11":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fcbdb868-b868-40c3-b318-960822ff0a94":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","scopes":[],"schemeName":"ApiKey"}}},"servers":{"c0c00d4e-7bf0-4fcd-989c-f0e3cfa4f7dc":{"url":"https://api.syntage.com","description":"Production"},"e5007030-8e8d-4029-845f-889b1bebb7c0":{"url":"https://api.sandbox.syntage.com","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-API-Key","type":"string","description":"Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashboards.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-API-Key"}],"title":"ApiKey"}]},"originalFileLocation":"openapi/openapi.yaml"},"subdomain":"syntage","siteName":"Syntage","title":"Retrieve an Entity - Syntage","navMaps":{"firstHrefInVersion":{"2020-06-28":{"href":"/api-reference/entities/retrieve-an-entity","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/api-reference/entities/retrieve-an-entity","matchLevel":0},"es":{"href":"/es","matchLevel":4}}},"lastModified":"2026-06-16T18:31:11.652Z","originalFileLocation":"api-reference/entities/retrieve-an-entity.mdx","locale":"en"},"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=\"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Syntage\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_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/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve an Entity - Syntage\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Syntage\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://syntage.mintlify.app/_mintlify/api/og/v2?division=Entities\u0026amp;title=Retrieve+an+Entity\u0026amp;description=Retrieve+a+single+entity+by+ID%2C+including+taxpayer%2C+credential%2C+and+tag+information+when+available.\u0026amp;theme=71db65a3f59ffd9e5f96cd77\u0026amp;signature=efebcadee8841e0c077f54604dbb5f9c7a6d9d36e678ff5a90a2a89a8901623c\">\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=\"Retrieve an Entity - Syntage\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://syntage.mintlify.app/_mintlify/api/og/v2?division=Entities\u0026amp;title=Retrieve+an+Entity\u0026amp;description=Retrieve+a+single+entity+by+ID%2C+including+taxpayer%2C+credential%2C+and+tag+information+when+available.\u0026amp;theme=71db65a3f59ffd9e5f96cd77\u0026amp;signature=efebcadee8841e0c077f54604dbb5f9c7a6d9d36e678ff5a90a2a89a8901623c\">\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/syntage/4Xa1qFNlW0Ql_9Ak/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Syntage\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1975FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/entities/retrieve-an-entity.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.syntage.com/#organization\",\"name\":\"Syntage\",\"url\":\"https://docs.syntage.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/syntage/NuYQc9gEjSxFZJMz/logo.svg?fit=max\u0026auto=format\u0026n=NuYQc9gEjSxFZJMz\u0026q=85\u0026s=976345a01e03638f59ea0f9cb2a7d8d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.syntage.com#website\",\"name\":\"Syntage\",\"url\":\"https://docs.syntage.com\",\"publisher\":{\"@id\":\"https://docs.syntage.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity#webpage\",\"url\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity\",\"name\":\"Retrieve an Entity\",\"description\":\"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.\",\"dateModified\":\"2026-06-16T18:31:11.652Z\",\"isPartOf\":{\"@id\":\"https://docs.syntage.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core Resources\",\"item\":\"https://docs.syntage.com/api-reference/events/list-all-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Entities\",\"item\":\"https://docs.syntage.com/api-reference/entities/list-all-entities\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve an Entity\",\"item\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity#apireference\",\"headline\":\"Retrieve an Entity\",\"name\":\"Retrieve an Entity\",\"description\":\"Retrieve a single entity by ID, including taxpayer, credential, and tag information when available.\",\"url\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity\",\"mainEntityOfPage\":{\"@id\":\"https://docs.syntage.com/api-reference/entities/retrieve-an-entity#webpage\"},\"dateModified\":\"2026-06-16T18:31:11.652Z\",\"publisher\":{\"@id\":\"https://docs.syntage.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.syntage.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Syntage\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Syntage","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Using Syntage","pages":[{"title":"Using Syntage","href":""}]},{"tab":"Resource Guide","pages":[{"title":"Resource Guide","href":"/resources/core/entities"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/developers/overview"}]},{"tab":"API Reference","versions":[{"version":"2020-06-28","default":true,"pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"group":"Core Resources","pages":[{"group":"Events","pages":[{"openapi":"get /events","title":"List all events","href":"/api-reference/events/list-all-events"},{"openapi":"get /events/{id}","title":"Retrieve an event","href":"/api-reference/events/retrieve-an-event"}]},{"group":"Files","pages":[{"openapi":"get /files/{id}","title":"Retrieve a file","href":"/api-reference/files/retrieve-a-file"},{"openapi":"get /files/{id}/download","title":"Download content","href":"/api-reference/files/download-the-file-content"}]},{"group":"Exports","pages":[{"openapi":"post /exports","title":"Export data","href":"/api-reference/exports/export-data"},{"openapi":"get /exports","title":"List all exports","href":"/api-reference/exports/list-all-exports"},{"openapi":"get /exports/{id}","title":"Retrieve an export","href":"/api-reference/exports/retrieve-an-export"}]},{"group":"Entities","pages":[{"openapi":"get /entities","title":"List all entities","href":"/api-reference/entities/list-all-entities"},{"openapi":"post /entities","title":"Add an Entity","description":"Add an entity to your organization.\n\nIf `datasources` contains one or more datasources, Syntage creates first-time extractions for the selected datasources. When a selected datasource has first-time scheduler rules, those rules determine which extractors and options are used. For selected datasources not covered by first-time scheduler rules, Syntage creates first-time extractions for the datasource's available extractors using the options from the request, or the extractor defaults.\n\nOmit `datasources` or send an empty array to create the entity without starting extractions.\n\n`name` is optional when you provide a valid RFC. If omitted or null, Syntage resolves the entity's legal name from taxpayer data during creation and stores that name on the entity. If no name is available for the RFC, the request fails with a validation error on `name` using the code `rfc_valid_no_name_on_file`; retry with an explicit `name` to create the entity.\n","href":"/api-reference/entities/add-an-entity"},{"openapi":"get /entities/{entityId}","title":"Retrieve an Entity","href":"/api-reference/entities/retrieve-an-entity"},{"openapi":"patch /entities/{entityId}","title":"Update an Entity","description":"Update an entity. Sending `tags` replaces the entity's existing tag assignments with the provided collection.","href":"/api-reference/entities/update-an-entity"},{"openapi":"delete /entities/{entityId}","title":"Delete an Entity","href":"/api-reference/entities/delete-an-entity"},{"group":"Favorites","pages":[{"title":"Favorite one or more entities","openapi":"post /entities/favorites","href":"/api-reference/entities/favorite-multiple-entities"},{"title":"Unfavorite one or more entities","openapi":"delete /entities/favorites","href":"/api-reference/entities/unfavorite-multiple-entities"}]},{"group":"Events","pages":[{"openapi":"get /entities/{entityId}/events","title":"List an entity's events","href":"/api-reference/entities/list-an-entitys-events"}]},{"group":"Identifiers","pages":[{"openapi":"get /entities/{entityId}/identifiers","title":"List an entity's identifiers","href":"/api-reference/entities/list-an-entitys-identifiers"},{"openapi":"post /entities/{entityId}/identifiers","title":"Add an entity identifier","href":"/api-reference/entities/add-an-entity-identifier"}]},{"group":"Entity Tags","pages":[{"openapi":"get /entities/{entityId}/tags","title":"List an entity's tags","href":"/api-reference/entities/list-an-entitys-tags"},{"openapi":"get /entity-tags","title":"List all entity tags","href":"/api-reference/entities/list-all-entity-tags"},{"openapi":"post /entity-tags","title":"Create an entity tag","href":"/api-reference/entities/create-an-entity-tag"},{"openapi":"get /entity-tags/{id}","title":"Retrieve an entity tag","href":"/api-reference/entities/retrieve-an-entity-tag"},{"openapi":"patch /entity-tags/{id}","title":"Update an entity tag","href":"/api-reference/entities/update-an-entity-tag"},{"openapi":"delete /entity-tags/{id}","title":"Delete an entity tag","href":"/api-reference/entities/delete-an-entity-tag"},{"openapi":"post /entities/batch/tags","title":"Tag multiple entities","href":"/api-reference/entities/tag-multiple-entities"},{"openapi":"post /entities/batch/tags/remove","title":"Untag multiple entities","href":"/api-reference/entities/untag-multiple-entities"}]}]},{"group":"Tags","pages":[{"openapi":"get /tags","title":"List all tags","href":"/api-reference/tags/list-all-tags"},{"openapi":"post /tags","title":"Create a tag","href":"/api-reference/tags/create-a-tag"},{"openapi":"delete /tags/{id}","title":"Delete a tag","href":"/api-reference/tags/delete-a-tag"},{"openapi":"patch /tags/{id}","title":"Update a tag","href":"/api-reference/tags/update-a-tag"}]},{"group":"Extractions","pages":[{"openapi":"get /extractions","title":"List all extractions","href":"/api-reference/extractions/list-all-extractions"},{"openapi":"post /extractions","title":"Create an extraction","href":"/api-reference/extractions/create-an-extraction"},{"openapi":"get /extractions/{id}","title":"Retrieve an extraction","href":"/api-reference/extractions/retrieve-an-extraction"},{"openapi":"delete /extractions/{id}/stop","title":"Request the extraction to be stopped","href":"/api-reference/extractions/request-the-extraction-to-be-stopped"},{"group":"Schedulers","pages":[{"openapi":"get /schedulers","title":"List schedulers","href":"/api-reference/schedulers/list-schedulers"},{"openapi":"post /schedulers","title":"Create a scheduler","href":"/api-reference/schedulers/create-an-scheduler"},{"openapi":"get /schedulers/{id}","title":"Retrieve a scheduler","href":"/api-reference/schedulers/retrieve-an-scheduler"},{"openapi":"put /schedulers/{id}","title":"Update a scheduler","href":"/api-reference/schedulers/update-an-scheduler"},{"openapi":"delete /schedulers/{id}","title":"Delete a scheduler","href":"/api-reference/schedulers/delete-an-scheduler"},{"group":"Rules","pages":[{"openapi":"post /schedulers/rules","title":"Create a scheduler rule","href":"/api-reference/scheduler-rules/create-an-scheduler-rule"},{"openapi":"get /schedulers/rules/{id}","title":"Retrieve a scheduler rule","href":"/api-reference/scheduler-rules/retrieve-an-scheduler-rule"},{"openapi":"put /schedulers/rules/{id}","title":"Update a scheduler rule","href":"/api-reference/scheduler-rules/update-an-scheduler-rule"},{"openapi":"delete /schedulers/rules/{id}","title":"Delete a scheduler rule","href":"/api-reference/scheduler-rules/delete-an-scheduler-rule"}]}]}]}]},{"group":"Other Resources","pages":[{"group":"Shareholders","pages":[{"openapi":"get /entities/{entityId}/shareholders","title":"List an entity's shareholders","href":"/api-reference/shareholders/get-an-entitys-shareholders"},{"openapi":"post /entities/{entityId}/shareholders","title":"Create a new shareholder for an entity","href":"/api-reference/shareholders/create-a-new-shareholder-for-an-entity"},{"openapi":"get /shareholders","title":"List shareholders","href":"/api-reference/shareholders/get-all-shareholders"},{"openapi":"get /shareholders/{id}","title":"Retrieve a shareholder","href":"/api-reference/shareholders/get-a-specific-shareholder"},{"openapi":"patch /shareholders/{id}","title":"Update a shareholder","href":"/api-reference/shareholders/update-a-shareholder"},{"openapi":"delete /shareholders/{id}","title":"Delete a shareholder","href":"/api-reference/shareholders/delete-a-shareholder"},{"group":"Relations","pages":[{"openapi":"get /shareholders/{shareholderId}/relations","title":"List shareholder relations","href":"/api-reference/shareholders/get-shareholder-relations"},{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}","title":"Retrieve a shareholder relation","href":"/api-reference/shareholders/get-a-specific-shareholder-relation"},{"openapi":"patch /shareholders/{shareholderId}/relations/{relationId}","title":"Update a shareholder relation","href":"/api-reference/shareholders/update-a-shareholder-relation"},{"openapi":"delete /shareholders/{shareholderId}/relations/{relationId}","title":"Delete a shareholder relation","href":"/api-reference/shareholders/delete-a-shareholder-relation"},{"openapi":"post /shareholders/{shareholderId}/relations/{relationId}/promote","title":"Promote a shareholder relation","href":"/api-reference/shareholders/promote-a-shareholder-relation"}]},{"group":"Sources","pages":[{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}/sources","title":"List shareholder relation sources","href":"/api-reference/shareholders/get-shareholder-relation-sources"},{"openapi":"get /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}","title":"Retrieve a shareholder relation source","href":"/api-reference/shareholders/get-a-specific-shareholder-relation-source"},{"openapi":"delete /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}","title":"Delete a shareholder relation source","href":"/api-reference/shareholders/delete-a-shareholder-relation-source"}]}]},{"group":"Background Checks","pages":[{"openapi":"get /background-checks","title":"List background checks","href":"/api-reference/background-checks/get-all-background-checks"},{"openapi":"get /background-checks/{id}","title":"Retrieve a background check","href":"/api-reference/background-checks/get-a-specific-background-check"},{"openapi":"get /background-checks/{id}/pdf","title":"Download background check PDF","href":"/api-reference/background-checks/get-background-check-pdf-report"},{"openapi":"get /entities/{entityId}/background-checks","title":"List an entity's background checks","href":"/api-reference/background-checks/get-an-entitys-background-checks"},{"openapi":"get /background-checks/{backgroundCheckId}/records","title":"List background check records","href":"/api-reference/background-checks/get-background-check-records"}]},{"group":"Company Verification Reports","pages":[{"openapi":"get /datasources/mx/company-verification/reports","title":"List company verification reports","href":"/api-reference/company-verification-reports/get-all-company-verification-reports"},{"openapi":"get /datasources/mx/company-verification/reports/{id}","title":"Retrieve a company verification report","href":"/api-reference/company-verification-reports/get-a-specific-company-verification-report"},{"openapi":"get /entities/{entityId}/datasources/mx/company-verification/reports","title":"List an entity's company verification reports","href":"/api-reference/company-verification-reports/get-an-entitys-company-verification-reports"}]},{"group":"Mexico Addresses","pages":[{"title":"Retrieve addresses by postal code","openapi":"get /datasources/mx/addresses/{postalCode}","href":"/api-reference/mexico-addresses/retrieve-addresses-by-postal-code"}]}]},{"group":"Datasource: SAT","pages":[{"group":"Credentials","pages":[{"openapi":"get /credentials","title":"List all credentials","href":"/api-reference/ds-mx-sat-credentials/list-all-credentials"},{"openapi":"post /credentials","title":"Create a credential","href":"/api-reference/ds-mx-sat-credentials/create-a-credential"},{"openapi":"get /credentials/{id}","title":"Retrieve a credential","href":"/api-reference/ds-mx-sat-credentials/retrieve-a-credential"},{"openapi":"delete /credentials/{id}","title":"Delete a credential","href":"/api-reference/ds-mx-sat-credentials/delete-a-credential"},{"openapi":"post /credentials/{id}/revalidate","title":"Revalidate a credential","href":"/api-reference/ds-mx-sat-credentials/revalidate-a-credential"}]},{"group":"Invoices","pages":[{"openapi":"get /invoices/{id}","title":"Retrieve an invoice","href":"/api-reference/ds-mx-sat-invoices/retrieve-an-invoice"},{"openapi":"post /invoices/{id}/tags","title":"Tag an invoice","href":"/api-reference/ds-mx-sat-invoices/tag-an-invoice"},{"openapi":"delete /invoices/{invoiceId}/tags/{tagId}","title":"Untag an invoice","href":"/api-reference/ds-mx-sat-invoices/untag-an-invoice"},{"openapi":"post /invoices/batch/tags","title":"Tag multiple invoices","href":"/api-reference/ds-mx-sat-invoices/tag-multiple-invoices"},{"openapi":"post /invoices/batch/tags/remove","title":"Untag multiple invoices","href":"/api-reference/ds-mx-sat-invoices/untag-multiple-invoices"},{"openapi":"get /invoices/{id}/cfdi","title":"Retrieve an invoice's CFDI","href":"/api-reference/ds-mx-sat-invoices/retrieve-an-invoices-cfdi"},{"openapi":"get /datasources/mx/sat/cfdis/{uuid}","title":"Retrieve a SAT CFDI","href":"/api-reference/ds-mx-sat-invoices/retrieve-a-sat-cfdi"},{"openapi":"get /entities/{entityId}/invoices","title":"List an entity's invoices","href":"/api-reference/ds-mx-sat-invoices/list-all-entities-invoices"},{"group":"Line Items","pages":[{"openapi":"get /invoices/line-items/{id}","title":"Retrieve an invoice line item","href":"/api-reference/ds-mx-sat-invoice-line-items/retrieve-an-invoice-line-item"},{"openapi":"get /invoices/{invoiceId}/line-items","title":"List an invoice's line items","href":"/api-reference/ds-mx-sat-invoice-line-items/list-an-invoices-line-items"},{"openapi":"get /entities/{entityId}/invoices/line-items","title":"List an entity's invoice line items","href":"/api-reference/ds-mx-sat-invoice-line-items/list-all-entity-line-items"}]},{"group":"Relations","pages":[{"openapi":"get /invoices/relations/{id}","title":"Retrieve an invoice relation","href":"/api-reference/ds-mx-sat-invoice-relations/retrieve-an-invoice-relation"},{"openapi":"get /invoices/{invoiceId}/relations","title":"List an invoice's relations","href":"/api-reference/ds-mx-sat-invoice-relations/list-an-invoices-relations"},{"openapi":"get /entities/{entityId}/invoices/{invoiceId}/relations","title":"List an entity's invoice relations","href":"/api-reference/ds-mx-sat-invoice-relations/list-an-entitys-invoice-relations"}]},{"group":"Payments","pages":[{"openapi":"get /invoices/payments","title":"List all invoice payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-all-invoice-payments"},{"openapi":"get /invoices/payments/{id}","title":"Retrieve an invoice payment","href":"/api-reference/ds-mx-sat-invoice-payments/retrieve-an-invoice-payment"},{"openapi":"get /invoices/{id}/payments","title":"List an invoice's payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-an-invoices-payments"},{"openapi":"get /entities/{entityId}/invoices/payments","title":"List an entity's invoice payments","href":"/api-reference/ds-mx-sat-invoice-payments/list-entities-invoice-payments"},{"group":"Batch Payments","pages":[{"openapi":"get /invoices/batch-payments","title":"List all invoice batch payments","href":"/api-reference/ds-mx-sat-invoice-batch-payments/list-all-invoice-batch-payments"},{"openapi":"get /invoices/batch-payments/{id}","title":"Retrieve an invoice batch payment","href":"/api-reference/ds-mx-sat-invoice-batch-payments/retrieve-an-invoice-batch-payment"},{"openapi":"get /invoices/{id}/batch-payments","title":"List an invoice's batch payments","href":"/api-reference/ds-mx-sat-invoice-batch-payments/list-an-invoices-batch-payments"}]}]},{"group":"Credit Notes","pages":[{"openapi":"get /invoices/credit-notes","title":"List credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-credit-notes"},{"openapi":"get /entities/{entityId}/invoices/credit-notes","title":"List an entity's credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-an-entitys-credit-notes"},{"openapi":"get /invoices/credit-notes/{id}","title":"Retrieve an invoice credit note","href":"/api-reference/ds-mx-sat-credit-notes/retrieve-an-invoice-credit-note"},{"openapi":"get /invoices/{invoiceId}/issued-credit-notes","title":"List an invoice's issued credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-all-issued-credit-notes-related-to-the-requested-invoice"},{"openapi":"get /invoices/{invoiceId}/applied-credit-notes","title":"List an invoice's applied credit notes","href":"/api-reference/ds-mx-sat-credit-notes/list-all-applied-credit-notes-related-to-the-requested-invoice"}]}]},{"group":"Tax Retentions","pages":[{"openapi":"get /tax-retentions/{id}","title":"Retrieve a tax retention","href":"/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention"},{"openapi":"get /tax-retentions/{id}/cfdi","title":"Retrieve a tax retention CFDI","href":"/api-reference/ds-mx-sat-tax-retentions/retrieve-a-tax-retention-cfdi"},{"openapi":"get /entities/{entityId}/tax-retentions","title":"List an entity's tax retentions","href":"/api-reference/ds-mx-sat-tax-retentions/list-all-entities-tax-retentions"}]},{"group":"Tax Returns","pages":[{"openapi":"get /tax-returns/{id}","title":"Retrieve a tax return","href":"/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return"},{"openapi":"get /tax-returns/{id}/pdf","title":"Download a tax return PDF","href":"/api-reference/ds-mx-sat-tax-returns/download-a-tax-return-pdf"},{"openapi":"get /tax-returns/{id}/data","title":"Retrieve tax return data","href":"/api-reference/ds-mx-sat-tax-returns/retrieve-a-tax-return-data"},{"openapi":"get /entities/{entityId}/tax-returns","title":"List an entity's tax returns","href":"/api-reference/ds-mx-sat-tax-returns/list-all-entities-tax-returns"}]},{"group":"Tax Compliance Checks","pages":[{"openapi":"get /tax-compliance-checks/{id}","title":"Retrieve a tax compliance check","href":"/api-reference/ds-mx-sat-tax-compliance-checks/retrieve-a-tax-compliance-check"},{"openapi":"get /entities/{entityId}/tax-compliance-checks","title":"List an entity's tax compliance checks","href":"/api-reference/ds-mx-sat-tax-compliance-checks/list-all-entities-tax-compliance-checks"}]},{"group":"Tax Status","pages":[{"openapi":"get /tax-status","title":"List tax status records","href":"/api-reference/ds-mx-sat-tax-status/list-tax-status-records"},{"openapi":"get /tax-status/{id}","title":"Retrieve a tax status","href":"/api-reference/ds-mx-sat-tax-status/retrieve-a-tax-status"},{"openapi":"get /entities/{entityId}/tax-status","title":"List an entity's tax status records","href":"/api-reference/ds-mx-sat-tax-status/list-all-entities-tax-status"}]},{"group":"Electronic Accounting","pages":[{"openapi":"get /electronic-accounting-records/{id}","title":"Retrieve an electronic accounting record","href":"/api-reference/ds-mx-sat-electronic-accounting/retrieve-an-electronic-accounting-record"},{"openapi":"get /entities/{entityId}/electronic-accounting-records","title":"List an entity's electronic accounting records","href":"/api-reference/ds-mx-sat-electronic-accounting/list-all-entities-electronic-accounting-records"}]},{"group":"Certificates","pages":[{"openapi":"get /datasources/mx/sat/certificados/{id}","title":"Retrieve a SAT certificate","href":"/api-reference/ds-mx-sat-certificates/retrieve-a-sat-certificate"},{"openapi":"get /entities/{entityId}/datasources/mx/sat/certificados","title":"List an entity's SAT certificates","href":"/api-reference/ds-mx-sat-certificates/list-an-entitys-sat-certificates"}]}]},{"group":"Datasource: RPC","pages":[{"group":"Entidades","pages":[{"openapi":"get /datasources/mx/rpc/entidades/{id}","title":"Retrieve RPC entidade","href":"/api-reference/ds-mx-rpc-entidades/retrieve-rpc-entidades-data-beta"},{"openapi":"get /entities/{entityId}/datasources/mx/rpc/entidades","title":"List an entity's RPC entidades","href":"/api-reference/ds-mx-rpc-entidades/list-all-entities-rpc-entidades-data-beta"}]},{"group":"Actos","pages":[{"openapi":"get /rpc/actos/{id}","title":"Retrieve RPC acto","href":"/api-reference/ds-mx-rpc-actos/retrieve-an-rpc-acto"},{"openapi":"get /entities/{entityId}/datasources/mx/rpc/actos","title":"List an entity's RPC actos","href":"/api-reference/ds-mx-rpc-actos/list-an-entitys-rpc-actos"}]},{"group":"Socios","pages":[{"openapi":"get /datasources/rpc/socios/{id}","title":"Retrieve RPC socio","href":"/api-reference/ds-mx-rpc-socios/retrieve-an-rpc-socio"}]}]},{"group":"Datasource: RUG","pages":[{"group":"Operaciones","pages":[{"openapi":"get /datasources/rug/operaciones/{id}","title":"Retrieve RUG operation","href":"/api-reference/ds-mx-rug-operaciones/retrieve-rug-operacion-data"},{"openapi":"get /entities/{entityId}/datasources/rug/operaciones","title":"List an entity's RUG operations","href":"/api-reference/ds-mx-rug-operaciones/list-all-entities-rug-operaciones-data"}]},{"group":"Garantias","pages":[{"openapi":"get /datasources/rug/garantias/{id}","title":"Retrieve RUG guarantee","href":"/api-reference/ds-mx-rug-garantias/retrieve-rug-garantia-data"},{"openapi":"get /entities/{entityId}/datasources/rug/garantias","title":"List an entity's RUG guarantees","href":"/api-reference/ds-mx-rug-garantias/list-all-entities-rug-garantias-data-beta"}]}]},{"group":"Datasource: Syntage","pages":[{"group":"Score","pages":[{"openapi":"post /entities/{entityId}/datasources/syntage/score/calculate","title":"Start Syntage Score calculation","href":"/api-reference/ds-syntage-score/calculate-syntage-score"}]}]},{"group":"Datasource: Buró de Crédito","pages":[{"group":"Reports","pages":[{"openapi":"get /entities/{entityId}/datasources/mx/buro-de-credito/reports","title":"Get an entity's Buró de Crédito reports","href":"/api-reference/ds-mx-buro-de-credito-reports/get-an-entitys-buro-de-credito-reports"},{"openapi":"get /datasources/mx/buro-de-credito/reports/{id}","title":"Get a Buró de Crédito report","href":"/api-reference/ds-mx-buro-de-credito-reports/get-a-buro-de-credito-report"}]},{"group":"Authorizations","pages":[{"openapi":"get /datasources/mx/buro-de-credito/authorizations","title":"Get Buró de Crédito authorizations","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-all-buro-de-credito-authorizations"},{"openapi":"get /entities/{entityId}/datasources/mx/buro-de-credito/authorizations","title":"Get an entity's Buró de Crédito authorizations","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-an-entitys-buro-de-credito-authorizations"},{"openapi":"post /entities/{entityId}/datasources/mx/buro-de-credito/authorizations","title":"Create a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/create-a-buro-de-credito-authorization"},{"openapi":"get /datasources/mx/buro-de-credito/authorizations/{id}","title":"Get a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/get-a-buro-de-credito-authorization"},{"openapi":"delete /datasources/mx/buro-de-credito/authorizations/{id}","title":"Delete a Buró de Crédito authorization","href":"/api-reference/ds-mx-buro-de-credito-authorizations/delete-a-buro-de-credito-authorization"}]}]},{"group":"Datasource: BIL","pages":[{"group":"Reports","pages":[{"openapi":"get /entities/{entityId}/datasources/bil/reports","title":"List an entity's BIL reports","href":"/api-reference/ds-mx-bil-reports/list-an-entitys-bil-reports"},{"openapi":"get /datasources/bil/reports/{id}","title":"Retrieve a BIL report","href":"/api-reference/ds-mx-bil-reports/retrieve-a-bil-report"}]}]},{"group":"Datasource: Infonavit","pages":[{"group":"Overdue Credits","pages":[{"openapi":"get /entities/{entityId}/datasources/infonavit/overdue-credits","title":"List an entity's Infonavit overdue credits","href":"/api-reference/ds-mx-infonavit-overdue-credits/list-an-entitys-infonavit-overdue-credits"},{"openapi":"get /datasources/infonavit/overdue-credits/{id}","title":"Retrieve an Infonavit overdue credit","href":"/api-reference/ds-mx-infonavit-overdue-credits/retrieve-an-infonavit-overdue-credit"}]}]},{"group":"Insights","pages":[{"group":"Company","pages":[{"title":"Summary Insight","openapi":"get /entities/{entityId}/insights/summary","href":"/api-reference/summary-insight/get-summary"},{"title":"Scores Insight","openapi":"get /entities/{entityId}/insights/metrics/scores","href":"/api-reference/scores-insight/get-scores"},{"title":"Syntage Score Distribution","openapi":"get /insights/metrics/scores/syntage/distribution","href":"/api-reference/scores-insight/get-syntage-score-distribution"},{"title":"Buró de Crédito Summary Insight","openapi":"get /entities/{entityId}/insights/metrics/buro-de-credito/summary","href":"/api-reference/buro-de-credito-summary-insight/get-buro-de-credito-summary"},{"title":"Buró de Crédito Summary Export","openapi":"get /entities/{entityId}/insights/metrics/buro-de-credito/summary/export","href":"/api-reference/buro-de-credito-summary-insight/export-buro-de-credito-summary"},{"title":"Risks Insight","openapi":"get /entities/{entityId}/insights/risks","href":"/api-reference/risks-insight/get-risk-calculations"},{"title":"RPC Shareholders Insight","openapi":"get /entities/{entityId}/insights/rpc-shareholders","deprecated":true,"href":"/api-reference/rpc-shareholders-insight/get-rpc-shareholders-beta"}]},{"group":"Corporate Structure","pages":[{"title":"Shareholders Insight","openapi":"get /entities/{entityId}/insights/shareholders","href":"/api-reference/shareholders-insight/get-shareholders"},{"title":"Current Powers Insight","openapi":"get /entities/{entityId}/insights/corporate-structure/current-powers","href":"/api-reference/corporate-structure-current-powers-insight/get-current-powers"}]},{"group":"Revenue","pages":[{"title":"Invoicing Annual Comparison Insight","openapi":"get /entities/{entityId}/insights/metrics/invoicing-annual-comparison","href":"/api-reference/invoicing-annual-comparison-insight/get-invoicing-annual-comparison-insight"},{"title":"Sales Revenue Insight","openapi":"get /entities/{entityId}/insights/sales-revenue","href":"/api-reference/sales-revenue-insight/get-sales-revenue"},{"title":"Expenditures Insight","openapi":"get /entities/{entityId}/insights/expenditures","href":"/api-reference/expenditures-insight/get-expenditures"},{"title":"Cash Flow Insight","openapi":"get /entities/{entityId}/insights/cash-flow-stats","href":"/api-reference/cash-flow-insight/get-cash-flow"},{"title":"Moratory Interest Insight","openapi":"get /entities/{entityId}/insights/moratory-interest","href":"/api-reference/moratory-interest-insight/get-moratory-interest"},{"title":"Accounts Payable Insight","openapi":"get /entities/{entityId}/insights/accounts-payable","href":"/api-reference/accounts-payable-insight/get-accounts-payable"},{"title":"Accounts Receivable Insight","openapi":"get /entities/{entityId}/insights/accounts-receivable","href":"/api-reference/accounts-receivable-insight/get-accounts-receivable"},{"title":"Invoicing Blacklist Insight","openapi":"get /entities/{entityId}/insights/invoicing-blacklist","href":"/api-reference/invoicing-blacklist-insight/get-invoicing-blacklist"}]},{"group":"Financial","pages":[{"title":"Balance Sheet Insight","openapi":"get /entities/{entityId}/insights/metrics/balance-sheet","href":"/api-reference/balance-sheet-insight/get-balance-sheet-metric"},{"title":"Income Statement Insight","openapi":"get /entities/{entityId}/insights/metrics/income-statement","href":"/api-reference/income-statement-insight/get-metrics-income-statement"},{"title":"Financial Ratios Insight","openapi":"get /entities/{entityId}/insights/financial-ratios","href":"/api-reference/financial-ratios-insight/get-financial-ratios"},{"title":"Trial Balance Insight","openapi":"get /entities/{entityId}/insights/trial-balance","href":"/api-reference/trial-balance-insight/get-trial-balance"}]},{"group":"Clients","pages":[{"title":"Customer Concentration Insight","openapi":"get /entities/{entityId}/insights/customer-concentration","href":"/api-reference/customer-concentration-insight/get-customer-invoice-concentration"},{"title":"Customer Network Insight","openapi":"get /entities/{entityId}/insights/metrics/customer-network","href":"/api-reference/customer-network-insight/get-customer-network-insight"},{"title":"Products and Services Sold Insight","openapi":"get /entities/{entityId}/insights/products-and-services-sold","href":"/api-reference/products-and-services-sold-insight/get-products-and-services-sold"},{"title":"Government Customers Insight","openapi":"get /entities/{entityId}/insights/government-customers","href":"/api-reference/government-customers-insight/get-government-customers"}]},{"group":"Providers","pages":[{"title":"Vendor Concentration Insight","openapi":"get /entities/{entityId}/insights/supplier-concentration","href":"/api-reference/vendor-concentration-insight/get-vendor-invoice-concentration"},{"title":"Vendor Network Insight","openapi":"get /entities/{entityId}/insights/metrics/vendor-network","href":"/api-reference/vendor-network-insight/get-vendor-network-insight"},{"title":"Products and Services Bought Insight","openapi":"get /entities/{entityId}/insights/products-and-services-bought","href":"/api-reference/products-and-services-bought-insight/get-products-and-services-bought"},{"title":"Financial Institutions Insight","openapi":"get /entities/{entityId}/insights/financial-institutions","href":"/api-reference/financial-institutions-insight/get-financial-institutions"},{"title":"Employees Insight","openapi":"get /entities/{entityId}/insights/employees","href":"/api-reference/employees-insight/get-employees"}]},{"title":"Invoicing Concentration Insight","openapi":"get /entities/{entityId}/insights/invoicing-concentration","deprecated":true,"href":"/api-reference/invoicing-concentration-insight/get-invoicing-concentration"},{"title":"Insight Export","openapi":"get /entities/{entityId}/insights/{insight}/export","href":"/api-reference/insights/export-an-insight"}]},{"group":"Reports","pages":[{"openapi":"get /reports","title":"List all reports","href":"/api-reference/reports/list-reports"},{"openapi":"post /reports","title":"Create a report","href":"/api-reference/reports/create-a-report"},{"openapi":"get /reports/{id}","title":"Retrieve a report","href":"/api-reference/reports/retrieve-a-report"},{"openapi":"put /reports/{id}","title":"Update a report","href":"/api-reference/reports/update-a-report"},{"openapi":"delete /reports/{id}","title":"Delete a report","href":"/api-reference/reports/delete-a-report"}]},{"group":"Webhooks","pages":[{"group":"Webhook Endpoints","pages":[{"openapi":"get /webhook-endpoints","title":"List webhook endpoints","href":"/api-reference/webhook-endpoints/list-all-webhook-endpoints"},{"openapi":"post /webhook-endpoints","title":"Create webhook endpoint","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"openapi":"get /webhook-endpoints/{id}","title":"Retrieve webhook endpoint","href":"/api-reference/webhook-endpoints/retrieve-a-webhook-endpoint"},{"openapi":"put /webhook-endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/webhook-endpoints/update-an-webhook-endpoint"},{"openapi":"delete /webhook-endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"}]},{"group":"Webhook Requests","pages":[{"openapi":"get /webhook-requests","title":"List webhook requests","href":"/api-reference/webhook-requests/list-all-webhook-requests"},{"openapi":"get /webhook-requests/{id}","title":"Retrieve webhook request","href":"/api-reference/webhook-requests/retrieve-a-webhook-request"}]}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"language":"es","pages":[{"title":"es","href":"/es"}]}]},"basePath":"","title":"Retrieve an Entity - Syntage","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"]}