> For the complete documentation index, see [llms.txt](https://docs.lhv.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lhv.com/home/connect/services/viban/open-a-viban-1-5.md).

# VIBAN Notification

{% hint style="info" %}
There is no request endpoint for this service as it is triggered by other events
{% endhint %}

## Response message

Service is used to send information to customers about Virtual IBAN status changes or any other updates that are triggered not by customer directly, but some updated on the Bank side - for example when account with screening match is activated (status changes from ON\_HOLD to ACTIVE).

Response message is created and can be requested by one the Messages services - [Messages Services](/home/connect/services/messages.md)

{% hint style="info" %}
HTTP Header Message-Response-Type: VIBAN\_STATUS\_NOTIFICATION
{% endhint %}

#### Body

{% file src="/files/UGjLnTkC2XdGmmgBZXNC" %}

XML structure description:

| MULT.   | MESSAGE ELEMENT        | XML TAG                    | Description                                                                                 |
| ------- | ---------------------- | -------------------------- | ------------------------------------------------------------------------------------------- |
| \[1..1] | +MessageRoot           | \<VibanStatusNotification> |                                                                                             |
| \[0..1] | ++ClientReference      | \<ClientReference>         | Customer reference defined by Payment Service Provider.                                     |
| \[1..1] | ++MasterAccount        | \<MasterAccount>           | Master account IBAN (must belong to PSP).                                                   |
| \[1..1] | ++VirtualIBAN          | \<VirtualIBAN>             | Virtual IBAN (must be issued under MasterAccount specified).                                |
| \[1..1] | ++User                 | \<User>                    |                                                                                             |
| \[0..1] | +++Person              | \<Person>                  | Element of choice, used if Virtual IBAN owner is private person.                            |
| \[1..1] | ++++Name               | \<Name>                    | First and last name of private person.                                                      |
| \[1..1] | ++++BirthDate          | \<BirthDate>               | Birth date of private person (YYYY-MM-DD).                                                  |
| \[0..1] | ++++BirthCountry       | \<BirthCountry>            | Country of birth of private person (ISO 3166-1 alpha-2).                                    |
| \[1..1] | ++++Residency          | \<Residency>               | Country of residence of private person (ISO 3166-1 alpha-2).                                |
| \[0..1] | ++++DocumentNumber     | \<DocumentNumber>          | Document number of private person.                                                          |
| \[0..1] | +++Company             | \<Company>                 | Element of choice, used if Virtual IBAN owner is legal person.                              |
| \[1..1] | ++++Name               | \<Name>                    | Name of company.                                                                            |
| \[1..1] | ++++CountryOfOrigin    | \<CountryOfOrigin>         | Country of origin of legal person (ISO 3166-1 alpha-2).                                     |
| \[1..1] | ++++TaxResidency       | \<TaxResidency>            | Tax residency of legal person (ISO 3166-1 alpha-2).                                         |
| \[1..1] | ++++RegistrationNumber | \<RegistrationNumber>      | Registration number of legal person.                                                        |
| \[1..1] | ++++Representative     | \<Representative>          |                                                                                             |
| \[1..1] | +++++Name              | \<Name>                    | First and last name of representative.                                                      |
| \[1..1] | +++++BirthDate         | \<BirthDate>               | Birth date of representative, YYYY-MM-DD.                                                   |
| \[1..1] | +++++Residency         | \<Residency>               | Country of residence of representative (ISO 3166-1 alpha-2).                                |
| \[1..1] | +++Address             | \<Address>                 |                                                                                             |
| \[1..1] | ++++Country            | \<Country>                 | Address country (ISO 3166-1 alpha-2).                                                       |
| \[1..1] | ++++StreetNo           | \<StreetNo>                | Street address.                                                                             |
| \[1..1] | ++++CityCounty         | \<CityCounty>              | City, county.                                                                               |
| \[1..1] | ++Status               | \<Status>                  | Status of Virtual IBAN: 'ACTIVE', 'ON\_HOLD', 'PENDING', 'REJECTED', 'BLOCKED' or 'CLOSED'. |
| \[0..1] | ++DateActivated        | \<DateActivated>           | Optional. Added if Virtual IBAN has been in activated.                                      |
| \[0..1] | ++DateClosed           | \<DateClosed>              | Optional. Added if Virtual IBAN has beel closed.                                            |

#### Samples

{% tabs %}
{% tab title="Private person" %}

```xml
<?xml version="1.0" encoding="UTF-8"?>
<VibanStatusNotification>
  <ClientReference>12345678</ClientReference>
  <MasterAccount>GB88LHVB01020000000001</MasterAccount>
  <VirtualIBAN>GB88LHVB01020000000002</VirtualIBAN>
  <User>
  	<Person>
  	  <Name>Donald Duck</Name>
  	  <BirthDate>1908-11-29</BirthDate>
  	  <BirthCountry>DE</BirthCountry>
  	  <Residency>DE</Residency>
  	  <DocumentNumber>A942819</DocumentNumber>
  	</Person>
  	<Address>
  		<Country>GB</Country>
  		<StreetNo>88 High Holborn</StreetNo>
  		<CityCounty>London</CityCounty>
  	</Address>
  </User>
  <Status>ACTIVE</Status>
  <!--Optional:-->
  <DateActivated>2018-01-01+02:00</DateActivated>
  <!--Optional:-->
  <DateClosed>2018-05-22+03:00</DateClosed>
</VibanStatusNotification>
```

{% endtab %}

{% tab title="Legal person" %}

```xml
<?xml version="1.0" encoding="UTF-8"?>
<VibanStatusNotification>
  <ClientReference>12345678</ClientReference>
  <MasterAccount>GB88LHVB01020000000001</MasterAccount>
  <VirtualIBAN>GB88LHVB01020000000002</VirtualIBAN>
  <User>
  	<Company>
  		<Name>UK Ltd Version 2.0</Name>
  		<CountryOfOrigin>GB</CountryOfOrigin>
  		<TaxResidency>GB</TaxResidency>
  		<RegistrationNumber>1849203</RegistrationNumber>
  		<Representative>
  			<Name>Harry Potter</Name>
  			<BirthDate>2001-01-01</BirthDate>
  			<Residency>GB</Residency>
  		</Representative>
  	</Company>
  	<Address>
  		<Country>GB</Country>
  		<StreetNo>Waterloo Bridge 13</StreetNo>
  		<CityCounty>London, Cold</CityCounty>
  	</Address>
  </User>
  <Status>ACTIVE</Status>
  <!--Optional:-->
  <DateActivated>2018-01-01+02:00</DateActivated>
  <!--Optional:-->
  <DateClosed>2018-05-22+03:00</DateClosed>
</VibanStatusNotification>
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.lhv.com/home/connect/services/viban/open-a-viban-1-5.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.