{
"errors": [
"The request is missing the required field `name`"
]
}
Retrieves the most recent income data for the account’s authorisation. May return an empty result if no new income is found.
This endpoint requires a valid authorisation for the user. If no active authorisation exists, the request will be rejected.
You can optionally pass the x-teal-authorisation-id header to specify which authorisation to use; otherwise the system will resolve a valid authorisation automatically.
See Authorisations for more details.
Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.
The ingestion entry created for this fetch. Null when no data was returned.
Example:
"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Teal","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/logo/light.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=f1f94f62054040d698706983d3b88016","dark":"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/logo/dark.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=e6414f548a8e27e0c07175a488d2f256"},"favicon":"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/favicon.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=dfb4da63f6b3fdca92c71519210b7ccd","navbar":{"links":[{"href":"mailto:hello@goteal.co","label":"Support"}]},"footer":{"socials":{"website":"https://goteal.co","linkedin":"https://www.linkedin.com/company/goteal"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"book-open-cover","href":"https://goteal.co"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"teal","hasAudioNarration":false,"actualSubdomain":"teal","customDomains":["docs.goteal.co"],"gitSource":{"type":"github","owner":"teal-connect","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6adb82c56e43bdfe55f01a95","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":45},{"language":"default","tag":"Accounts","count":7},{"language":"default","tag":"Authorisations","count":7},{"language":"default","tag":"Doc Scan","count":6},{"language":"default","tag":"Payroll","count":6},{"language":"default","tag":"Users","count":6},{"language":"default","tag":"Documentation","count":5},{"language":"default","tag":"Get Started","count":5},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Configuration","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/gov-connect/connections-create","slug":"/api-reference/gov-connect/connections-create","pageMetadata":{"title":"Query Gov Connection","openapi":"POST /gov-connect/entries/connections","description":null,"href":"/api-reference/gov-connect/connections-create"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Retrieves the most recent income data for the account’s authorisation. May return an empty result if no new income is found.`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`This endpoint requires a valid authorisation for the user. If no active authorisation exists, the request will be rejected.\nYou can optionally pass the `,_jsx(_components.code,{children:`x-teal-authorisation-id`}),` header to specify which authorisation to use; otherwise the system will resolve a valid authorisation automatically.\nSee `,_jsx(_components.a,{href:`/authorisations`,children:`Authorisations`}),` for more details.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Query Gov Connection","openapi":"POST /gov-connect/entries/connections","description":null,"href":"/api-reference/gov-connect/connections-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Fetch and store Gov Connect (HMRC) income data for an account","parameters":["2fadd743-9e66-4114-a0b2-0524ab1d2b2c"],"security":["13475dfa-ad71-43b4-930e-007900629880"],"requestBody":"c95623c8-a436-4a8d-b7b4-66fbca6ad4e9","responses":{"200":"f487b95c-7359-47ee-ac34-d8f8c25696c9","201":"2226f8c2-1cbc-4dd9-9968-a847df1f8171","400":"78eaf60e-2179-48dc-9c5b-410b0ca49c3a","401":"43eb70fb-da3d-413c-a653-35b99afc07ca","403":"83dd184d-3cc3-45e1-a81f-e8607636d9f1"},"method":"post","type":"path","servers":["742833a9-e448-4843-b38b-cd5bf228a9b1","77e4d818-25f3-46e0-88a5-6a8a8c77be0b"],"path":"/gov-connect/entries/connections","baseUrlOptions":["https://api.sandbox.goteal.co","https://api.goteal.co"],"title":"Fetch and store Gov Connect (HMRC) income data for an account","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2fadd743-9e66-4114-a0b2-0524ab1d2b2c":{"name":"x-teal-authorisation-id","in":"header","required":false,"description":"Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.","schema":{"type":"string","format":"uuid","example":"7f3b8c2a-1d4e-4f6a-8b8c-9a0b1c2d3e4f","isRequired":false,"description":"Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_id"],"properties":{"account_id":{"type":"string","format":"uuid","description":"The Gov Connect (HMRC) account id to fetch income data for","example":"95a0e70b-fe02-4f47-aef9-2efff279df71","isRequired":true,"uniqueKey":"account_id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"account_id":"95a0e70b-fe02-4f47-aef9-2efff279df71"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f487b95c-7359-47ee-ac34-d8f8c25696c9":{"description":"OK — no new income data was returned","content":{"application/json":{"schema":{"type":"object","required":["account_id","gov_connect_submissions"],"properties":{"account_id":{"type":"string","format":"uuid","description":"The account the income data belongs to","example":"95a0e70b-fe02-4f47-aef9-2efff279df71","isRequired":true,"uniqueKey":"account_id","typeLabel":"string\u003cuuid>"},"gov_connect_submissions":{"type":"array","items":{"type":"object","description":"A single Gov Connect (HMRC) income submission in the Making Tax Digital (MTD) shape. Only the fields present for the taxpayer are returned; empty fields are omitted. All monetary values are returned as strings.","required":["id","account_id","entry_id","authorisation_id"],"properties":{"id":{"type":"string","format":"uuid","description":"The submission id","example":"3f1c0b9a-1e2d-4a5b-9c8d-0e1f2a3b4c5d","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"account_id":{"type":"string","format":"uuid","example":"95a0e70b-fe02-4f47-aef9-2efff279df71","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].account_id","typeLabel":"string\u003cuuid>"},"entry_id":{"type":"string","format":"uuid","example":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].entry_id","typeLabel":"string\u003cuuid>"},"authorisation_id":{"type":"string","format":"uuid","example":"9f8e7d6c-5b4a-3210-fedc-ba9876543210","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].authorisation_id","typeLabel":"string\u003cuuid>"},"income_id":{"type":"string","description":"Stable identifier for the income record","example":"2025-26:emp:se:prop","uniqueKey":"gov_connect_submissions.items.[INDEX].income_id","typeLabel":"string"},"identity":{"type":"object","properties":{"name":{"type":"string","example":"Fred Bloggs","uniqueKey":"gov_connect_submissions.items.[INDEX].identity.name","typeLabel":"string"},"date_of_birth":{"type":"string","example":"1980-02-20","uniqueKey":"gov_connect_submissions.items.[INDEX].identity.date_of_birth","typeLabel":"string"},"ni_number":{"type":"string","example":"QQ000001A","uniqueKey":"gov_connect_submissions.items.[INDEX].identity.ni_number","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].identity","typeLabel":"object"},"employments":{"type":"array","items":{"type":"object","properties":{"employment":{"type":"object","properties":{"employer_name":{"type":"string","example":"NEW CORP","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.employer_name","typeLabel":"string"},"paye_reference":{"type":"string","example":"120/NC15208","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.paye_reference","typeLabel":"string"},"status":{"type":"string","example":"active","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.status","typeLabel":"string"},"start_date":{"type":"string","example":"2024-06-10T00:00Z","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.start_date","typeLabel":"string"},"leave_date":{"oneOf":[{"type":"string","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.leave_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.leave_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.leave_date","typeLabel":"string | null"},"tax_code":{"oneOf":[{"type":"string","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.tax_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.tax_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.tax_code","typeLabel":"string | null"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment","typeLabel":"object"},"income":{"type":"object","properties":{"tax_year":{"type":"string","example":"2024-25","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income.tax_year","typeLabel":"string"},"taxable_income":{"type":"string","example":"28100.91","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income.taxable_income","typeLabel":"string"},"tax_paid":{"type":"string","example":"3611.40","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income.tax_paid","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income","typeLabel":"object"},"updated_at":{"type":"string","example":"2026-06-05 13:03:39","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].updated_at","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments","typeLabel":"object[]"},"self_employments":{"type":"array","items":{"type":"object","properties":{"business":{"type":"object","properties":{"business_id":{"type":"string","example":"XBIS1","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].business.business_id","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].business","typeLabel":"object"},"income":{"type":"object","properties":{"tax_year":{"type":"string","example":"2024-25","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.tax_year","typeLabel":"string"},"turnover":{"type":"string","example":"92500.00","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.turnover","typeLabel":"string"},"other_income":{"type":"string","example":"1200.00","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.other_income","typeLabel":"string"},"tax_deducted_at_source":{"type":"string","example":"0.00","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.tax_deducted_at_source","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income","typeLabel":"object"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments","typeLabel":"object[]"},"properties":{"type":"array","items":{"type":"object","properties":{"property_id":{"type":"string","example":"XPIS1","uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX].property_id","typeLabel":"string"},"tax_year":{"type":"string","example":"2024-25","uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX].tax_year","typeLabel":"string"},"rent_received":{"type":"string","example":"747.45","uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX].rent_received","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"gov_connect_submissions.items.[INDEX].properties","typeLabel":"object[]"}},"uniqueKey":"gov_connect_submissions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"gov_connect_submissions","typeLabel":"object[]"},"entry_id":{"oneOf":[{"type":"string","format":"uuid","description":"The ingestion entry created for this fetch. Null when no data was returned.","example":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","uniqueKey":"entry_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The ingestion entry created for this fetch. Null when no data was returned.","example":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","uniqueKey":"entry_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entry_id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"account_id":"95a0e70b-fe02-4f47-aef9-2efff279df71","gov_connect_submissions":[{"id":"3f1c0b9a-1e2d-4a5b-9c8d-0e1f2a3b4c5d","account_id":"95a0e70b-fe02-4f47-aef9-2efff279df71","entry_id":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","authorisation_id":"9f8e7d6c-5b4a-3210-fedc-ba9876543210","income_id":"2025-26:emp:se:prop","identity":{"name":"Fred Bloggs","date_of_birth":"1980-02-20","ni_number":"QQ000001A"},"employments":[{"employment":{"employer_name":"NEW CORP","paye_reference":"120/NC15208","status":"active","start_date":"2024-06-10T00:00Z","leave_date":"\u003cstring>","tax_code":"\u003cstring>"},"income":{"tax_year":"2024-25","taxable_income":"28100.91","tax_paid":"3611.40"},"updated_at":"2026-06-05 13:03:39"}],"self_employments":[{"business":{"business_id":"XBIS1"},"income":{"tax_year":"2024-25","turnover":"92500.00","other_income":"1200.00","tax_deducted_at_source":"0.00"}}],"properties":[{"property_id":"XPIS1","tax_year":"2024-25","rent_received":"747.45"}]}],"entry_id":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"}}},"exampleType":"generated"}},"exampleType":"generated"},"2226f8c2-1cbc-4dd9-9968-a847df1f8171":{"description":"Created — income data was fetched and stored","content":{"application/json":{"schema":{"type":"object","required":["account_id","gov_connect_submissions"],"properties":{"account_id":{"type":"string","format":"uuid","description":"The account the income data belongs to","example":"95a0e70b-fe02-4f47-aef9-2efff279df71","isRequired":true,"uniqueKey":"account_id","typeLabel":"string\u003cuuid>"},"gov_connect_submissions":{"type":"array","items":{"type":"object","description":"A single Gov Connect (HMRC) income submission in the Making Tax Digital (MTD) shape. Only the fields present for the taxpayer are returned; empty fields are omitted. All monetary values are returned as strings.","required":["id","account_id","entry_id","authorisation_id"],"properties":{"id":{"type":"string","format":"uuid","description":"The submission id","example":"3f1c0b9a-1e2d-4a5b-9c8d-0e1f2a3b4c5d","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"account_id":{"type":"string","format":"uuid","example":"95a0e70b-fe02-4f47-aef9-2efff279df71","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].account_id","typeLabel":"string\u003cuuid>"},"entry_id":{"type":"string","format":"uuid","example":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].entry_id","typeLabel":"string\u003cuuid>"},"authorisation_id":{"type":"string","format":"uuid","example":"9f8e7d6c-5b4a-3210-fedc-ba9876543210","isRequired":true,"uniqueKey":"gov_connect_submissions.items.[INDEX].authorisation_id","typeLabel":"string\u003cuuid>"},"income_id":{"type":"string","description":"Stable identifier for the income record","example":"2025-26:emp:se:prop","uniqueKey":"gov_connect_submissions.items.[INDEX].income_id","typeLabel":"string"},"identity":{"type":"object","properties":{"name":{"type":"string","example":"Fred Bloggs","uniqueKey":"gov_connect_submissions.items.[INDEX].identity.name","typeLabel":"string"},"date_of_birth":{"type":"string","example":"1980-02-20","uniqueKey":"gov_connect_submissions.items.[INDEX].identity.date_of_birth","typeLabel":"string"},"ni_number":{"type":"string","example":"QQ000001A","uniqueKey":"gov_connect_submissions.items.[INDEX].identity.ni_number","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].identity","typeLabel":"object"},"employments":{"type":"array","items":{"type":"object","properties":{"employment":{"type":"object","properties":{"employer_name":{"type":"string","example":"NEW CORP","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.employer_name","typeLabel":"string"},"paye_reference":{"type":"string","example":"120/NC15208","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.paye_reference","typeLabel":"string"},"status":{"type":"string","example":"active","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.status","typeLabel":"string"},"start_date":{"type":"string","example":"2024-06-10T00:00Z","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.start_date","typeLabel":"string"},"leave_date":{"oneOf":[{"type":"string","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.leave_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.leave_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.leave_date","typeLabel":"string | null"},"tax_code":{"oneOf":[{"type":"string","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.tax_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.tax_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment.tax_code","typeLabel":"string | null"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].employment","typeLabel":"object"},"income":{"type":"object","properties":{"tax_year":{"type":"string","example":"2024-25","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income.tax_year","typeLabel":"string"},"taxable_income":{"type":"string","example":"28100.91","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income.taxable_income","typeLabel":"string"},"tax_paid":{"type":"string","example":"3611.40","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income.tax_paid","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].income","typeLabel":"object"},"updated_at":{"type":"string","example":"2026-06-05 13:03:39","uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX].updated_at","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"gov_connect_submissions.items.[INDEX].employments","typeLabel":"object[]"},"self_employments":{"type":"array","items":{"type":"object","properties":{"business":{"type":"object","properties":{"business_id":{"type":"string","example":"XBIS1","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].business.business_id","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].business","typeLabel":"object"},"income":{"type":"object","properties":{"tax_year":{"type":"string","example":"2024-25","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.tax_year","typeLabel":"string"},"turnover":{"type":"string","example":"92500.00","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.turnover","typeLabel":"string"},"other_income":{"type":"string","example":"1200.00","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.other_income","typeLabel":"string"},"tax_deducted_at_source":{"type":"string","example":"0.00","uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income.tax_deducted_at_source","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX].income","typeLabel":"object"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"gov_connect_submissions.items.[INDEX].self_employments","typeLabel":"object[]"},"properties":{"type":"array","items":{"type":"object","properties":{"property_id":{"type":"string","example":"XPIS1","uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX].property_id","typeLabel":"string"},"tax_year":{"type":"string","example":"2024-25","uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX].tax_year","typeLabel":"string"},"rent_received":{"type":"string","example":"747.45","uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX].rent_received","typeLabel":"string"}},"uniqueKey":"gov_connect_submissions.items.[INDEX].properties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"gov_connect_submissions.items.[INDEX].properties","typeLabel":"object[]"}},"uniqueKey":"gov_connect_submissions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"gov_connect_submissions","typeLabel":"object[]"},"entry_id":{"oneOf":[{"type":"string","format":"uuid","description":"The ingestion entry created for this fetch. Null when no data was returned.","example":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","uniqueKey":"entry_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The ingestion entry created for this fetch. Null when no data was returned.","example":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","uniqueKey":"entry_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entry_id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"account_id":"95a0e70b-fe02-4f47-aef9-2efff279df71","gov_connect_submissions":[{"id":"3f1c0b9a-1e2d-4a5b-9c8d-0e1f2a3b4c5d","account_id":"95a0e70b-fe02-4f47-aef9-2efff279df71","entry_id":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e","authorisation_id":"9f8e7d6c-5b4a-3210-fedc-ba9876543210","income_id":"2025-26:emp:se:prop","identity":{"name":"Fred Bloggs","date_of_birth":"1980-02-20","ni_number":"QQ000001A"},"employments":[{"employment":{"employer_name":"NEW CORP","paye_reference":"120/NC15208","status":"active","start_date":"2024-06-10T00:00Z","leave_date":"\u003cstring>","tax_code":"\u003cstring>"},"income":{"tax_year":"2024-25","taxable_income":"28100.91","tax_paid":"3611.40"},"updated_at":"2026-06-05 13:03:39"}],"self_employments":[{"business":{"business_id":"XBIS1"},"income":{"tax_year":"2024-25","turnover":"92500.00","other_income":"1200.00","tax_deducted_at_source":"0.00"}}],"properties":[{"property_id":"XPIS1","tax_year":"2024-25","rent_received":"747.45"}]}],"entry_id":"1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e"}}},"exampleType":"generated"}},"exampleType":"generated"},"78eaf60e-2179-48dc-9c5b-410b0ca49c3a":{"description":"Bad request if one of the required parameters is missing","content":{"application/json":{"schema":{"required":["errors"],"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"An array of messages describing the errors","example":["The request is missing the required field `name`"],"isRequired":true,"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["The request is missing the required field `name`"]}}},"exampleType":"generated"}},"exampleType":"generated"},"43eb70fb-da3d-413c-a653-35b99afc07ca":{"description":"Unauthorized if the X-API-KEY is not provided or is wrong","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"An array of messages describing the errors","example":["Not Authorization: Bearer \u003ctoken> provided or wrong value"],"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["Not Authorization: Bearer \u003ctoken> provided or wrong value"]}}},"exampleType":"generated"}},"exampleType":"generated"},"83dd184d-3cc3-45e1-a81f-e8607636d9f1":{"description":"Forbidden — the user does not have a valid authorisation","content":{"application/json":{"schema":{"required":["errors"],"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"description":"An array of messages describing the errors","example":["The request is missing the required field `name`"],"isRequired":true,"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["The request is missing the required field `name`"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"13475dfa-ad71-43b4-930e-007900629880":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"742833a9-e448-4843-b38b-cd5bf228a9b1":{"url":"https://api.sandbox.goteal.co","description":"Sandbox server for experiments"},"77e4d818-25f3-46e0-88a5-6a8a8c77be0b":{"url":"https://api.goteal.co","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"teal","siteName":"Teal","title":"Query Gov Connection - Teal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T15:52:42.988Z","originalFileLocation":"api-reference/gov-connect/connections-create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Teal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_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/teal/LMHi1fxtC26ppOnK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Query Gov Connection - Teal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Teal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.goteal.co/api-reference/gov-connect/connections-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://teal.mintlify.site/_mintlify/api/og/v2?division=Gov+Connect\u0026amp;title=Query+Gov+Connection\u0026amp;theme=e8808eb87529d6c1643a320b\u0026amp;signature=452af32efac15899542519072b53016493775e32454511effc2bad2f7feecf3c\">\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=\"Query Gov Connection - Teal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://teal.mintlify.site/_mintlify/api/og/v2?division=Gov+Connect\u0026amp;title=Query+Gov+Connection\u0026amp;theme=e8808eb87529d6c1643a320b\u0026amp;signature=452af32efac15899542519072b53016493775e32454511effc2bad2f7feecf3c\">\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/teal/LMHi1fxtC26ppOnK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Teal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.goteal.co/api-reference/gov-connect/connections-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/gov-connect/connections-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.goteal.co/#organization\",\"name\":\"Teal\",\"url\":\"https://docs.goteal.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/teal/Bcr09DVpVxdrVRJl/logo/light.svg?fit=max\u0026auto=format\u0026n=Bcr09DVpVxdrVRJl\u0026q=85\u0026s=f1f94f62054040d698706983d3b88016\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.goteal.co#website\",\"name\":\"Teal\",\"url\":\"https://docs.goteal.co\",\"publisher\":{\"@id\":\"https://docs.goteal.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create#webpage\",\"url\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create\",\"name\":\"Query Gov Connection\",\"dateModified\":\"2026-10-23T15:52:42.988Z\",\"isPartOf\":{\"@id\":\"https://docs.goteal.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Teal\",\"item\":\"https://docs.goteal.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Query Gov Connection\",\"item\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create#apireference\",\"headline\":\"Query Gov Connection\",\"name\":\"Query Gov Connection\",\"url\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.goteal.co/api-reference/gov-connect/connections-create#webpage\"},\"dateModified\":\"2026-10-23T15:52:42.988Z\",\"publisher\":{\"@id\":\"https://docs.goteal.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.goteal.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Teal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Teal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/gov-connect/connections-create.md","siteName":"Teal","nav":{"global":{"anchors":[{"anchor":"Website","icon":"book-open-cover","href":"https://goteal.co"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Quickstart","href":"/api-reference/quickstart"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Users","pages":[{"title":"Create a User","openapi":"POST /users","href":"/api-reference/users/create"},{"title":"Retrieve a user","openapi":"GET /users/{user_id}","href":"/api-reference/users/get"},{"title":"Update a User","openapi":"PATCH /users/{user_id}","href":"/api-reference/users/update"},{"title":"List all users","openapi":"GET /users","href":"/api-reference/users/list"},{"title":"List all recurring users","openapi":"GET /users/recurring","href":"/api-reference/users/list-recurring"},{"title":"Delete a user","openapi":"DELETE /users/{user_id}","href":"/api-reference/users/delete"}]},{"group":"User Token","pages":[{"title":"Generate User token","openapi":"POST /user-tokens","href":"/api-reference/users/tokens"}]},{"group":"Accounts","pages":[{"title":"Create an account","openapi":"POST /accounts","href":"/api-reference/accounts/create"},{"title":"Submit MFA response","openapi":"PUT /accounts/{account_id}/mfa","href":"/api-reference/accounts/mfa"},{"title":"Direct Connection","openapi":"POST /accounts/direct-connections","href":"/api-reference/accounts/direct-connections-create"},{"title":"List all accounts","openapi":"GET /accounts","href":"/api-reference/accounts/list"},{"title":"List all recurring accounts","openapi":"GET /accounts/recurring","href":"/api-reference/accounts/list-recurring"},{"title":"Get an account","openapi":"GET /accounts/{account_id}","href":"/api-reference/accounts/get"},{"title":"Delete an account","openapi":"DELETE /accounts/{account_id}","href":"/api-reference/accounts/delete"}]},{"group":"Payroll","pages":[{"title":"Query Payroll Connection","openapi":"POST /payroll/entries/connections","href":"/api-reference/payroll/connections-create"},{"title":"Generate presigned payslip URLs","openapi":"POST /payroll/entries/payslips/presign","href":"/api-reference/payroll/payslips-presign"},{"title":"Payslips upload","openapi":"POST /payroll/entries/payslips","href":"/api-reference/payroll/payslips-create"},{"title":"Get Payroll","openapi":"GET /payroll/{user_id}","href":"/api-reference/payroll/get"},{"title":"List all entries","openapi":"GET /payroll/entries","href":"/api-reference/payroll/entries-list"},{"title":"Delete an entry","openapi":"DELETE /payroll/entries/{entry_id}","href":"/api-reference/payroll/entries-delete"}]},{"group":"Expenditure","pages":[{"title":"Get ONS expenditure","openapi":"GET /expenditure/{user_id}/ons","description":"Estimates cost of living and housing from the user's payroll periods,\ndate of birth, and postcode using the Teal V3.0 ONS Family Spending\nmodel (table A6).\n\nNet pay is split across calendar months by overlapping days. Age is\ntaken as of the last day of each month from that period's date of\nbirth (else the user's) and adjusts cost of living only.\nRegion (from each period's postcode prefix, else the user's first\npostcode that has an ONS region) adjusts housing only.\n\nMonths are skipped, not returned, when their net pay is zero or\nnegative (refunds, reversals) or when no postcode for the month has\nan ONS region (for example GY, JE, IM or an unknown postcode).\n\n`404` lists each missing or invalid input as its own string in\n`errors`:\n- `User [\u003cuser_id>] not found`\n- `[date_of_birth] param is missing on the user and its payslips`\n- `[post_codes] param is missing on the user and its payslips`\n- `[date_of_birth] param \u003cdate> is after the payslip month`\n- `[date_of_birth] param \u003cdate> gives an age over 150, the ONS model limit`\n- `Postcode \u003cpostcode> has no ONS region; supported: England, Wales, Scotland, Northern Ireland`\n (only when no month has a postcode with a region)\n- `payroll periods are missing`\n- `payroll periods have no positive net pay`\n","href":"/api-reference/expenditure/ons"}]},{"group":"Gov Connect","pages":[{"title":"Query Gov Connection","openapi":"POST /gov-connect/entries/connections","href":"/api-reference/gov-connect/connections-create"},{"title":"Get Gov Connect income","openapi":"GET /gov-connect/{user_id}","description":null,"href":"/api-reference/gov-connect/get"}]},{"group":"Doc Scan","pages":[{"title":"Lists all documents","openapi":"GET /documents","href":"/api-reference/documents/list"},{"title":"Retrieve a specific document","openapi":"GET /documents/{document_id}","href":"/api-reference/documents/get"},{"title":"Delete a document","openapi":"DELETE /documents/{document_id}","href":"/api-reference/documents/delete"},{"title":"Presign bank statement uploads","openapi":"PUT /documents/bank-statements/presign","href":"/api-reference/documents/bank-statements-presign"},{"title":"Upload bank statements","openapi":"PUT /documents/bank-statements","href":"/api-reference/documents/bank-statements-upload"},{"title":"List bank statement submissions","openapi":"GET /bankstatements/{user_id}","href":"/api-reference/documents/bank-statements-get"}]},{"group":"Authorisations","pages":[{"title":"Create an Authorisation Term","openapi":"POST /authorisations/terms","href":"/api-reference/authorisations/terms-create"},{"title":"List Authorisation Terms","openapi":"GET /authorisations/terms","href":"/api-reference/authorisations/terms-list"},{"title":"Get an Authorisation Term","openapi":"GET /authorisations/terms/{term_id}","href":"/api-reference/authorisations/terms-get"},{"title":"Get Latest Term for User","openapi":"GET /authorisations/terms/latest","href":"/api-reference/authorisations/terms-latest"},{"title":"Record Authorisation Acceptance","openapi":"POST /authorisations","href":"/api-reference/authorisations/create"},{"title":"List User Authorisations","openapi":"GET /authorisations","href":"/api-reference/authorisations/list"},{"title":"Revoke an Authorisation","openapi":"PUT /authorisations/{authorisation_id}/revoke","href":"/api-reference/authorisations/revoke"}]},{"group":"Providers","pages":[{"title":"List all providers","openapi":"GET /providers","href":"/api-reference/providers/list"}]},{"group":"Configuration","pages":[{"title":"Get client configuration","openapi":"GET /configuration","href":"/api-reference/configuration/get"},{"title":"Update client configuration","openapi":"PATCH /configuration","href":"/api-reference/configuration/update"}]},{"group":"Webhooks","pages":[{"title":"Create a Webhook","openapi":"POST /webhooks","href":"/api-reference/webhooks/create"},{"title":"Retrieve a Webhook","openapi":"GET /webhooks/{webhook_id}","href":"/api-reference/webhooks/get"},{"title":"List all webhooks","openapi":"GET /webhooks","href":"/api-reference/webhooks/list"},{"title":"Delete a Webhook","openapi":"DELETE /webhooks/{webhook_id}","href":"/api-reference/webhooks/delete"}]}]}]},"basePath":"","title":"Query Gov Connection - Teal","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}