Skip to main content
POST
/
hmrc
/
entries
/
connections
Connects a user account to HMRC
curl --request POST \
  --url https://api.sandbox.goteal.co/hmrc/entries/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "95a0e70b-fe02-4f47-aef9-2efff279df71"
}
'
{
  "account_id": "82b49a09-b352-4a67-abe1-09764417084a",
  "entry_id": "cd9a4666-6bde-4aea-8ade-bdb9751b848f",
  "income_submissions": [
    {
      "id": "cefbbff7-f405-467c-8f7e-1421be42c796",
      "account_id": "82b49a09-b352-4a67-abe1-09764417084a",
      "entry_id": "b98ee82a-0c24-4dc6-acb3-c8b2735505f4",
      "income_id": "13de317b69d5d0e3033455a670cb318b",
      "employment": {
        "total_income": "31150.00",
        "employers": [
          {
            "employer_name": "Company XYZ",
            "income": "22500.00",
            "tax_paid": "890.35"
          }
        ]
      },
      "frequency": "Annual",
      "income_period": {
        "start": "2024-04-06T12:00:00Z",
        "end": "2025-04-05T12:00:00Z"
      }
    }
  ]
}
HMRC connections require fraud prevention headers. See the Fraud Headers section for details.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication. The token should be the one returned by the /user-tokens endpoint.

Body

application/json
​
account_id
string<uuid>
required

The account id to use to connect to HMRC

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

Response

Created

​
account_id
string<uuid>
required

The id of the account

Example:

"82b49a09-b352-4a67-abe1-09764417084a"

​
entry_id
string<uuid>
required

The id of the entry

Example:

"cd9a4666-6bde-4aea-8ade-bdb9751b848f"

​
income_submissions
object[]
required