You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "API Simulator OVERRRIDE Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. "
3
+
"description": "Use this API to look up the full address for a UK postcode. Includes an optional filter to narrow by house number and street name.",
4
+
"identifier": "address-lookup"
5
+
},
6
+
{
7
+
"description": "For tax agents requesting authorisation to act on a client’s behalf.\n\nReplacing the 64-8 paper form, use this API to set up new authorisation requests and check the status, cancel or query a request.",
8
+
"identifier": "agent-authorisation-api"
9
+
},
10
+
{
11
+
"description": "For testing only. Test accepting or rejecting an authorisation request created using the Agent Authorisation API.",
"description": "Create dummy individual, agent, and organisation accounts for testing user-restricted endpoints in our sandbox.",
16
+
"identifier": "api-platform-test-user"
17
+
},
18
+
{
19
+
"description": "Set up test data to verify expected behaviour for the Breathing Space API.",
20
+
"identifier": "breathing-space-if-dynamic-stub"
21
+
},
22
+
{
23
+
"description": "Create, update and view Breathing Space periods. Use an individual’s NINO to get personal information about coded-out and current debts.",
24
+
"identifier": "breathing-space-if-proxy"
25
+
},
26
+
{
27
+
"description": "Use this API to list all businesses associated with an individual and retrieve additional information each business.",
28
+
"identifier": "business-details-api"
29
+
},
30
+
{
31
+
"description": "This API allows users to search, view and manage property services in relation to business rates. \n\nRequires pre-registration with the Valuation Office Agency (VOA).",
32
+
"identifier": "business-rates-api"
33
+
},
34
+
{
35
+
"description": "This API allows users to check if an importer/exporter’s UK Economic Operator Registration Identification (EORI) number is valid. This is for numbers beginning ‘GB’.",
36
+
"identifier": "check-eori-number-api"
37
+
},
38
+
{
39
+
"description": "View and manage Construction Industry Scheme (CIS) deductions.\n\nUse this API to retrieve, create, remove and override information CIS contractors have submitted to HMRC.",
40
+
"identifier": "cis-deductions-api"
41
+
},
42
+
{
43
+
"description": "Use the Common Transit Convention (CTC) API to tell traders their guarantee funds balance.",
"description": "The Common Transit Convention (CTC) API sends departure and arrival notifications to the New Computerised Transit System (NCTS). It also retrieves messages from departure and destination customs offices.",
48
+
"identifier": "common-transit-convention-traders"
49
+
},
50
+
{
51
+
"description": "An API to submit Union Custom Code (UCC) Declarations for processing and approval by the Customs Declaration Service. It allows users to cancel a pre-request while in pre-clearance, and provides a route to securely upload additional documentation.",
52
+
"identifier": "customs-declarations"
53
+
},
54
+
{
55
+
"description": "Use this API to search and get details of a Customs Declaration. Users can search based on role, category, date, goods location code and status.",
56
+
"identifier": "customs-declarations-information"
57
+
},
58
+
{
59
+
"description": "Enables functionality for the Inventory Linking Export process to control and monitor cargo in transit.\n\nThis API supports three functional areas: consolidation, movement and query.",
60
+
"identifier": "customs-inventory-linking-exports"
61
+
},
62
+
{
63
+
"description": "This API validates movement response messages provided by Community System Providers (CSP). It matches the outcome of a Declaration ID against an Inventory Consignment Reference (ICR).",
64
+
"identifier": "customs-inventory-linking-imports"
65
+
},
66
+
{
67
+
"description": "An API to test email events including delivered, bounced, opened and clicked links.",
68
+
"identifier": "email-events"
69
+
},
70
+
{
71
+
"description": "Submit information to the Excise Movement Control System (EMCS) including movement notices, view messages from EMCS and retrieve information about traders.",
"description": "Provides a Shared Signals Framework to accept security related events to HMRC. The GDS signals are transmitted in the form of a Security Event Token (SET) which are signed and verified.",
76
+
"identifier": "gds-signals-receiver"
77
+
},
78
+
{
79
+
"description": "This API links declaration references, the movement of goods to declarations, and notifies users when their inbound goods have successfully cleared HMRC systems in the UK.",
80
+
"identifier": "goods-movement-system-carrier-api"
81
+
},
82
+
{
83
+
"description": "This API creates, updates and deletes Goods Movement Records (GMRs). It lists active GMRs and notifies users when inbound goods have successfully cleared UK HMRC systems.",
84
+
"identifier": "goods-movement-system-haulier-api"
85
+
},
86
+
{
87
+
"description": "Get Goods Movement Records (GRM) details that have embarked, arrived or checked-in for departure at a Goods Vehicle Movement Service (GVMS) border location. This API also gets GVMS reference data.",
88
+
"identifier": "goods-movement-system-port-api"
89
+
},
90
+
{
91
+
"description": "Find Goods Movement Records (GMR) for customs and transit declaration IDs, or Vehicle Registration Numbers. Get GVMS reference data and place inspection holds on GMRs moving on the Great Britain to Northern Ireland route.",
92
+
"identifier": "goods-movement-system-search-api"
93
+
},
94
+
{
95
+
"description": "This API gets questions from a set of identifiers and matches the user entered response.",
96
+
"identifier": "identity-verification-questions"
97
+
},
98
+
{
99
+
"description": "This API will generate a list of, acknowledge and retrieve Entry Summary Declarations (ENS) notifications.",
"description": "Supporting the process of goods arriving in Northern Ireland, this API allows users to submit presentation notifications to Customs, check inspection dates and notify Customs where goods don’t need inspection.",
"description": "Provide information about an employee, or director’s benefits, as reported to HMRC by the employer.\n\nThis API is designed to pre-populate an individual’s Self-Assessment tax return.",
116
+
"identifier": "individual-benefits"
117
+
},
118
+
{
119
+
"description": "Use this API to trigger, list, retrieve and submit a customer’s self-assessment tax calculation.",
120
+
"identifier": "individual-calculations-api"
121
+
},
122
+
{
123
+
"description": "This API shares information HMRC holds including; employment history, employer PAYE reference, employer’s name and an off payroll work flag where applicable.",
124
+
"identifier": "individual-employment"
125
+
},
126
+
{
127
+
"description": "This API shares information HMRC holds including; employment history, employer PAYE reference, employer’s name and an off payroll work flag where applicable.",
128
+
"identifier": "individual-income"
129
+
},
130
+
{
131
+
"description": "This API shares information HMRC holds including; employment history, employer PAYE reference, employer’s name and an off payroll work flag where applicable.",
132
+
"identifier": "individual-income-des-stub"
133
+
},
134
+
{
135
+
"description": "This API provides financial data and allows users to create, show, update and delete Brought Forward Losses and Loss Claims.",
136
+
"identifier": "individual-losses-api"
137
+
},
138
+
{
139
+
"description": "Retrieve the information HMRC holds about an individual’s tax affairs including; tax deducted from their annual gross income, pensions, incapacity benefit, and tax refunds.",
140
+
"identifier": "individual-tax"
141
+
},
142
+
{
143
+
"description": "Submit a declaration confirming the submission date for a business has completed.",
144
+
"identifier": "individuals-business-eops-api"
145
+
},
146
+
{
147
+
"description": "An API to provide financial data for pensions charges. Use this API to retrieve, create, amend and delete pension charges.",
148
+
"identifier": "individuals-charges-api"
149
+
},
150
+
{
151
+
"description": "An API which allows agents to manage Child Benefit claims. Includes: get claimants relationships and details of their children, create a Child Benefit claim and match birth registration.",
152
+
"identifier": "individuals-child-benefit-api"
153
+
},
154
+
{
155
+
"description": "This API creates, amends, retrieves and deletes data relating to Marriage Allowance and Individuals Disclosures.",
156
+
"identifier": "individuals-disclosures-api"
157
+
},
158
+
{
159
+
"description": "This API creates, amends, retrieves and deletes data relating to Trade Union income, Patent Royalties and existing employment expenses.",
160
+
"identifier": "individuals-expenses-api"
161
+
},
162
+
{
163
+
"description": "For testing only. Create dummy user details, PAYE, benefits and credits test data for an individual. This API will also create self assessment, corporation tax, VAT and multiple employee test data for an organisation.",
164
+
"identifier": "individuals-if-api-stub"
165
+
},
166
+
{
167
+
"description": "Get information about an individual's income from employment, pensions and retirement annuities and other state benefits or grants.",
168
+
"identifier": "individuals-income-received-api"
169
+
},
170
+
{
171
+
"description": "Get HMRC records to find out information about an individual.",
172
+
"identifier": "individuals-matching-api"
173
+
},
174
+
{
175
+
"description": "Create, amend, retrieve and delete data relating to relief from investments and subscriptions.",
176
+
"identifier": "individuals-reliefs-api"
177
+
},
178
+
{
179
+
"description": "Create, amend and retrieve information relating to an individual’s State Benefits.",
180
+
"identifier": "individuals-state-benefits-api"
181
+
},
182
+
{
183
+
"description": "Allow 3rd-party supplies to submit scanned copies of VAT returns for insolvent companies.",
184
+
"identifier": "insolvent-vat-api"
185
+
},
186
+
{
187
+
"description": "This API calculates the interest accrued to one or multiple customer debts. It retrieves configurable information including the interest rates applied, and a debt calculation.",
188
+
"identifier": "interest-forecasting"
189
+
},
190
+
{
191
+
"description": "Appoint or revoke a Reporting Company’s access to submit Interest Restriction Returns (IRR). This API also enables submission of full or abbreviated Interest Restriction Returns.",
192
+
"identifier": "interest-restriction-return"
193
+
},
194
+
{
195
+
"description": "An API that checks if users are authorised to create and retrieve session data.",
196
+
"identifier": "iv-orchestration"
197
+
},
198
+
{
199
+
"description": "Create and manage lifetime ISA (LISA) accounts including requesting and transferring event details, withdrawals and debt information.",
200
+
"identifier": "lisa-api"
201
+
},
202
+
{
203
+
"description": "An API to get Marriage Allowance status and check eligibility.",
204
+
"identifier": "marriage-allowance"
205
+
},
206
+
{
207
+
"description": "Create test data for the Marriage Allowance API.",
208
+
"identifier": "marriage-allowance-des-stub"
209
+
},
210
+
{
211
+
"description": "Send a single or multiple events to the tax platform for auditing.",
212
+
"identifier": "mobile-audit"
213
+
},
214
+
{
215
+
"description": "Get details of the Help to Save account for HMRC Mobile app.",
216
+
"identifier": "mobile-help-to-save"
217
+
},
218
+
{
219
+
"description": "Get a metadata list of all the user's digital messages such as Digital Contact or Online Letters from HMRC.",
220
+
"identifier": "mobile-messages"
221
+
},
222
+
{
223
+
"description": "Get PAYE data in a defined format for HMRC Mobile App developers.",
224
+
"identifier": "mobile-paye"
225
+
},
226
+
{
227
+
"description": "A calling system to send push notifications to the HMRC mobile app.",
"description": "Get startup data to initialise mobile apps. This API uses an authentication token to identify the National Insurance Number (NINO) to identify the user.",
"description": "Submits user feedback from HMRC Mobile app when a feedback submission is added to the queue.",
248
+
"identifier": "mobile-user-contact"
249
+
},
250
+
{
251
+
"description": "Get test support for MTD Self-Assessment APIs.",
252
+
"identifier": "mtd-sa-test-support-api"
253
+
},
254
+
{
255
+
"description": "View earnings subject to National Insurance (NI) and payments due.\n\nThis API is primarily used to calculate a taxpayer’s NI liability within Self Assessment.",
256
+
"identifier": "national-insurance"
257
+
},
258
+
{
259
+
"description": "Set up test data to use with the National Insurance API.",
260
+
"identifier": "national-insurance-des-stub"
261
+
},
262
+
{
263
+
"description": "Get a National Insurance record summary and tax year details.",
264
+
"identifier": "national-insurance-record"
265
+
},
266
+
{
267
+
"description": "Check national insurance numbers insights from Customer Insight Platform.",
268
+
"identifier": "nino-gateway"
269
+
},
270
+
{
271
+
"description": "This API retrieves obligations for business income sources, final declaration and the End of Period Statement.",
272
+
"identifier": "obligations-api"
273
+
},
274
+
{
275
+
"description": "This API allows 3rd-party providers to update HMRC on the status of Open Banking payments.",
276
+
"identifier": "open-banking-external-api"
277
+
},
278
+
{
279
+
"description": "This API creates, amends, retrieves and deletes deductions.",
280
+
"identifier": "other-deductions-api"
281
+
},
282
+
{
283
+
"description": "Set up test data for use with individual PAYE APIs including Individual Benefits, Individual Employment, Individual Income and Individual Tax.",
284
+
"identifier": "paye-des-stub"
285
+
},
286
+
{
287
+
"description": "This API allows 3rd-parties to check if a payment card is valid for use with a given tax regime, and reports applicable surcharges.",
288
+
"identifier": "payments-bin-check"
289
+
},
290
+
{
291
+
"description": "Send charge reference information to ETMP via DES and update the tps-payments-backend mongo repository with the information received.",
292
+
"identifier": "payments-processor"
293
+
},
294
+
{
295
+
"description": "An API that allows users to manage UK, Foreign, Historic and Non-Furnished Holiday Let (FHL) submission and summaries.",
296
+
"identifier": "property-business-api"
297
+
},
298
+
{
299
+
"description": "Send (push) and get (pull) notifications using this API.",
300
+
"identifier": "push-pull-notifications-api"
301
+
},
302
+
{
303
+
"description": "Check a pension scheme member’s residency for tax purposes and making relief at source claims.",
304
+
"identifier": "ras-api"
305
+
},
306
+
{
307
+
"description": "This API lists the files available for download through the Secure Data Exchange Service (SDES) and provides a download URL.",
"description": "This API creates URLs for uploading one or multiple files to HMRC’s Secure Data Exchange Service (SDES). It is designed for use with Web Forms.",
"description": "Retrieve overall liability broken down into overdue, payable and pending amounts.",
320
+
"identifier": "self-assessment-accounts-api"
321
+
},
322
+
{
323
+
"description": "This API manages generating the HMRC Assist Report.",
324
+
"identifier": "self-assessment-assist"
325
+
},
326
+
{
327
+
"description": "Retrieve a summary of income and expenditure for a specific self-employment, or property business.",
328
+
"identifier": "self-assessment-biss-api"
329
+
},
330
+
{
331
+
"description": "An API to access Business Source Adjustable Summary (BSAS) calculations for self-employment or a property business.\n\nGenerate lists, request/provide a BSAS and adjustments.",
332
+
"identifier": "self-assessment-bsas-api"
333
+
},
334
+
{
335
+
"description": "Perform operations related to Individuals/Taxable Entities for Income Tax Self Assessment.",
"description": "Manage annual and period summaries and submissions for self employment.",
340
+
"identifier": "self-employment-business-api"
341
+
},
342
+
{
343
+
"description": "Get a link to a web-session for the current API user.",
344
+
"identifier": "sso-session-api"
345
+
},
346
+
{
347
+
"description": "Use this API to send a browser link containing a session info ID.",
348
+
"identifier": "sso-session-link-api"
349
+
},
350
+
{
351
+
"description": "For the Department of Work and Pensions (DWP) only. Calculate an individual’s state pension.",
352
+
"identifier": "state-pension-calculation"
353
+
},
354
+
{
355
+
"description": "An API to generate a customers’ statement of liability.",
356
+
"identifier": "statement-of-liability"
357
+
},
358
+
{
359
+
"description": "This API verifies a user’s identity through a telephony system by checking personal information including partner’s date of birth, bank account number or previous postcode. It logs whether the attempt was successful or failed.",
"description": "Create individual, VAT trader, employer entities that can be accessed using the Telephony Identity Verification API. For use in the sandbox environment.",
"description": "Use this API to generate or promote a Time To Pay (TTP) request, get or update existing TTP plans, and return affordable quotes.",
368
+
"identifier": "time-to-pay-proxy"
369
+
},
370
+
{
371
+
"description": "Check the value and format of fraud prevention headers on individual requests. The API provides feedback if issues are found.",
372
+
"identifier": "txm-fph-validator-api"
373
+
},
374
+
{
375
+
"description": "Manage VAT reporting including submitting and viewing a return, plus retrieve information about liability, payments, penalties and obligations. ",
376
+
"identifier": "vat-api"
377
+
},
378
+
{
379
+
"description": "Check the registration and company details for UK VAT numbers. This API also generates a reference to prove a check has been made.",
0 commit comments