View a life event

View life event data that has been submitted to HMRC. You can view death and terminal illness, property purchase funds release, property purchase extension, property purchase outcome, and annual return of information.

Test data

<table style="font-family:Roboto, sans-serif; font-size:14px;"> <col width="40%"> <col width="60%"> <thead> <tr> <th>Scenario</th> <th>Response</th> </tr> </thead> <tbody> <tr> <td> Terminal illness life event lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 1234567891 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "1234567891", "eventType" : "LISA Investor Terminal Ill Health", "eventDate" : "2017-04-20" } ] </pre> </td> </tr> <tr> <td> Annual return of information which has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 7890000001 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "7890000001", "eventType": "Statutory Submission", "eventDate": "2018-04-05", "lisaManagerName": "Company Name", "taxYear": 2018, "marketValueCash": 0, "marketValueStocksAndShares": 55, "annualSubsCash": 0, "annualSubsStocksAndShares": 55, "supersededBy": "7890000002" } ] </pre> </td> </tr> <tr> <td> Annual return of information which supersedes another lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 7890000002 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "7890000002", "eventType": "Statutory Submission", "eventDate": "2018-04-05", "lisaManagerName": "Company Name", "taxYear": 2018, "marketValueCash": 0, "marketValueStocksAndShares": 65, "annualSubsCash": 0, "annualSubsStocksAndShares": 65, "supersede": { "originalLifeEventId": "7890000001", "originalEventDate": "2018-04-05" } } ] </pre> </td> </tr> <tr> <td> Funds release which has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 3456789000 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "3456789000", "eventType": "Funds release", "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" }, "supersededBy": "3456789001" } ] </pre> </td> </tr> <tr> <td> Funds release which has associated data and successful outcome lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 3456789001 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "3456789001", "eventType": "Funds release", "eventDate": "2017-05-05", "withdrawalAmount": 5000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" }, "supersede": { "originalLifeEventId": "3456789000", "originalEventDate": "2017-05-10" } }, { "lifeEventId": "6789000002", "eventType": "Extension one", "eventDate": "2017-05-11", "fundReleaseId": "3456789001", "supersede": { "originalLifeEventId": "6789000001", "originalEventDate": "2017-05-10" } }, { "lifeEventId": "6789000004", "eventType": "Extension two", "eventDate": "2017-08-11", "fundReleaseId": "3456789001", "supersede": { "originalLifeEventId": "6789000003", "originalEventDate": "2017-08-10" } }, { "lifeEventId": "5678900002", "eventType": "Purchase outcome", "eventDate": "2017-10-10", "fundReleaseId": "3456789001", "propertyPurchaseValue": 250000, "propertyPurchaseResult": "Purchase completed", "supersede": { "originalLifeEventId": "5678900001", "originalEventDate": "2017-10-05" } } ] </pre> </td> </tr> <tr> <td> Funds release with failure outcome lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567891 lifeEventId: 3456789002 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "3456789002", "eventType": "Funds release", "eventDate": "2017-05-05", "withdrawalAmount": 5000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" }, "supersede": { "originalLifeEventId": "3456789000", "originalEventDate": "2017-05-10" } }, { "lifeEventId": "5678900003", "eventType": "Purchase outcome", "eventDate": "2017-10-10", "fundReleaseId": "3456789002", "propertyPurchaseResult": "Purchase failed" } ] </pre> </td> </tr> <tr> <td> Purchase extension one which has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 6789000001 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "6789000001", "eventType": "Extension one", "eventDate": "2017-05-10", "fundReleaseId": "3456789001", "supersededBy": "6789000002" } ] </pre> </td> </tr> <tr> <td> Purchase extension one which supersedes another lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 6789000002 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "6789000002", "eventType": "Extension one", "eventDate": "2017-05-11", "fundReleaseId": "3456789001", "supersede": { "originalLifeEventId": "6789000001", "originalEventDate": "2017-05-10" } } ] </pre> </td> </tr> <tr> <td> Purchase extension two which has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 6789000003 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "6789000003", "eventType": "Extension two", "eventDate": "2017-08-10", "fundReleaseId": "3456789001", "supersededBy": "6789000004" } ] </pre> </td> </tr> <tr> <td> Purchase extension two which supersedes another lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 6789000004 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "6789000004", "eventType": "Extension two", "eventDate": "2017-08-11", "fundReleaseId": "3456789001", "supersede": { "originalLifeEventId": "6789000003", "originalEventDate": "2017-08-10" } } ] </pre> </td> </tr> <tr> <td> Purchase outcome which has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 5678900001 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "5678900001", "eventType": "Purchase outcome", "eventDate": "2017-10-05", "fundReleaseId": "3456789001", "propertyPurchaseValue": 250000, "propertyPurchaseResult": "Purchase completed", "supersededBy": "5678900002" } ] </pre> </td> </tr> <tr> <td> Purchase outcome which supersedes another lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 5678900002 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "5678900002", "eventType": "Purchase outcome", "eventDate": "2017-10-10", "fundReleaseId": "3456789001", "propertyPurchaseValue": 250000, "propertyPurchaseResult": "Purchase completed", "supersede": { "originalLifeEventId": "5678900001", "originalEventDate": "2017-10-05" } } ] </pre> </td> </tr> <tr> <td> Purchase outcome failure lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567891 lifeEventId: 5678900003 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> [ { "lifeEventId": "5678900003", "eventType": "Purchase outcome", "eventDate": "2017-10-10", "fundReleaseId": "3456789002", "propertyPurchaseResult": "Purchase failed" } ] </pre> </td> </tr> <tr> <td> lisaManagerReferenceNumber is in the wrong format lisaManagerReferenceNumber: 123456 accountId: 1234567890 lifeEventId: 1234567891 </td> <td> HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "Enter lisaManagerReferenceNumber in the correct format, like Z1234" } </pre> </td> </tr> <tr> <td> accountId is in the wrong format lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234%3D5678 lifeEventId: 1234567891 </td> <td> HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "Enter accountId in the correct format, like ABC12345" } </pre> </td> </tr> <tr> <td> Account not found lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 0000000404 lifeEventId: 1234567891 </td> <td> HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "INVESTOR_ACCOUNTID_NOT_FOUND", "message": "Enter a real accountId" } </pre> </td> </tr> <tr> <td> Life event not found lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 lifeEventId: 0000000404 </td> <td> HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "LIFE_EVENT_NOT_FOUND", "message": "The lifeEventId does not match with HMRC’s records" } </pre> </td> </tr> </tbody> </table>

lisaManagerReferenceNumberstring required

Example:Z1234

The reference given to the LISA provider when they applied for approval from HMRC.

accountIdstring required

Example:ABC12345

The ID for the account. This will be generated by the LISA Manager and will only be unique when used in combination with lisaManagerReferenceNumber. Any special characters should be URL encoded.

lifeEventIdstring required

Example:1234567890

The ID for the life event.

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Authorizationstring required

Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with appropriate scope.

Response

OK

lifeEventIdstring required

The ID for the life event.

The type of life event.

eventDatestring required

The date the life event occurred. This cannot be in the future.

lisaManagerNamestring

The name of the LISA provider.

taxYearinteger

The tax year for the return of information. This will be the year that the tax year ends in. For example, for the 2017 to 2018 tax year it will be 2018.

marketValueCashinteger

The total value that was reported for the cash LISA account.

marketValueStocksAndSharesinteger

The total value that was reported for the stocks and shares LISA account.

annualSubsCashinteger

The total value that was reported for investor subscriptions into their cash LISA account during the tax year.

annualSubsStocksAndSharesinteger

The total value that was reported for investor subscriptions into their stocks and shares LISA account during the tax year.

withdrawalAmountnumber

This is the amount that the investor has withdrawn from the LISA account.

conveyancerReferencestring

This is the reference for the conveyancer involved with the property purchase.

fundReleaseIdstring

The ID of the fund release for an extension or purchase outcome.

propertyPurchaseValuenumber

The value of the property that the investor purchased. Only included if the purchase was completed.

propertyPurchaseResult'Purchase failed' | 'Purchase completed'

Whether a property purchase was completed or failed.

supersededBystring

The ID of the life event that supersedes the current one.

Example response

[
  {
    "lifeEventId": "0987654321",
    "eventDate": "2017-05-20",
    "lisaManagerName": "Company Name",
    "taxYear": 2018,
    "marketValueCash": 1000,
    "marketValueStocksAndShares": 1000,
    "annualSubsCash": 100,
    "annualSubsStocksAndShares": 100,
    "conveyancerReference": "CR12345-6789",
    "propertyDetails": {
      "nameOrNumber": "Flat A",
      "postalCode": "AA1 1AA"
    },
    "fundReleaseId": "0987654321",
    "supersede": {
      "originalLifeEventId": "0987654321",
      "originalEventDate": "2017-05-20"
    },
    "supersededBy": "0987654321"
  }
]

v1

View a life event

Test data

Path parameters

Headers

Response

Example response