Get account details

Use an account ID to get account details.

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> Request with a valid LISA Manager reference number and account ID (open account) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "accountId": "1234567890", "investorId": "9876543210", "creationReason": "New", "firstSubscriptionDate": "2017-04-06", "accountStatus": "OPEN", "subscriptionStatus": "ACTIVE" } </pre> </td> </tr> <tr> <td> Request with a valid LISA Manager reference number and account ID (transferred account) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567891 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "accountId": "1234567891", "investorId": "9876543210", "creationReason": "Transferred", "firstSubscriptionDate": "2017-04-06", "accountStatus": "OPEN", "subscriptionStatus": "AVAILABLE", "transferAccount": { "transferredFromAccountId": "8765432100", "transferredFromLMRN": "Z654321", "transferInDate": "2017-04-06" } } </pre> </td> </tr> <tr> <td> Request with a valid LISA Manager reference number and account ID (Current year funds transferred) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567892 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "accountId": "1234567892", "investorId": "9876543210", "creationReason": "Current year funds transferred", "firstSubscriptionDate": "2017-04-06", "accountStatus": "OPEN", "subscriptionStatus": "AVAILABLE", "transferAccount": { "transferredFromAccountId": "8765432100", "transferredFromLMRN": "Z654321", "transferInDate": "2017-04-06" } } </pre> </td> </tr> <tr> <td> Request with a valid LISA Manager reference number and account ID (Previous year funds transferred) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567893 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "accountId": "1234567893", "investorId": "9876543210", "creationReason": "Previous year funds transferred", "firstSubscriptionDate": "2017-04-06", "accountStatus": "OPEN", "subscriptionStatus": "AVAILABLE", "transferAccount": { "transferredFromAccountId": "8765432100", "transferredFromLMRN": "Z654321", "transferInDate": "2017-04-06" } } </pre> </td> </tr> <tr> <td> Request with a valid LISA Manager reference number and account ID (voided account) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1000000200 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "accountId": "1000000200", "investorId": "9876543210", "creationReason": "New", "firstSubscriptionDate": "2017-04-06", "accountStatus": "VOID", "subscriptionStatus": "VOID" } </pre> </td> </tr> <tr> <td> Request with a valid LISA Manager reference number and account ID (closed account) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 2000000200 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "accountId": "2000000200", "investorId": "9876543210", "creationReason": "New", "firstSubscriptionDate": "2017-04-06", "accountStatus": "CLOSED", "subscriptionStatus": "VOID", "accountClosureReason": "All funds withdrawn", "closureDate": "2017-10-25" } </pre> </td> </tr> <tr> <td> Request with a valid account ID, but an invalid LISA Manager reference number lisaManagerReferenceNumber: 123456 accountId: 1234567890 </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> Request with a valid LISA Manager reference number, but an invalid account ID lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234%3D5678 </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> Request containing an account ID that does not exist lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 0000000404 </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> Request with an invalid 'Accept' header lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 Accept: application/vnd.hmrc.1.0 </td> <td> HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "MATCHING_RESOURCE_NOT_FOUND", "message": "A resource with the name in the request can not be found in the API" } </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.

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

investorIdstring required

The investor’s ID reference number.

accountIdstring required

The provider’s own unique reference number for the investor’s LISA account.

creationReason'New' | 'Transferred' | 'Current year funds transferred' | 'Previous year funds transferred' | 'Reinstated' required

The reason the account was created.

firstSubscriptionDatestring required

The date of the first deposit into the account - if this is a transfer, use the date of deposit into the account managed by the previous provider. This cannot be in the future.

accountStatus'OPEN' | 'VOID' | 'CLOSED' required

The status of the account.

subscriptionStatus'AVAILABLE' | 'ACTIVE' | 'LOCKED' | 'CANCELLED' | 'VOID' required

The subscription status for the current tax year.

accountClosureReason'All funds withdrawn' | 'Cancellation' | 'Transferred out' | 'Voided'

The reason the account was closed.

closureDatestring

The date the account was closed. This cannot be in the future.

Example response

{
  "investorId": "1234567890",
  "accountId": "AB9876543210",
  "firstSubscriptionDate": "2017-04-20",
  "closureDate": "2017-04-20",
  "transferAccount": {
    "transferredFromAccountId": "AB9876543210",
    "transferredFromLMRN": "Z1234",
    "transferInDate": "2017-04-20"
  }
}

v1

Get account details

Test data

Path parameters

Headers

Response

Example response