POST VerifyLogin/{validateRule}/{hideExceptionLevel}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| validateRule | LoginRule |
Required |
|
| hideExceptionLevel | HideExceptionLevel |
Default value is ConvertToHttpStatus |
Body Parameters
CustomerKeysAndAuth| Name | Description | Type | Additional information |
|---|---|---|---|
| isLoginOnBehalfOf | TrueFalse |
None. |
|
| isMyHomeAdminUser | TrueFalse |
None. |
|
| dataSource | DataSourceEnum |
None. |
|
| partnerName | string |
None. |
|
| customerIdApi | string |
None. |
|
| customerIdSource | string |
None. |
|
| GuidLogin | globally unique identifier |
None. |
|
| GuidLoginRef | globally unique identifier |
None. |
|
| customerRules |
R=Use GuidLoginRef at login M=Use always mobilnumer at login ( same email is used for different persons e.g. ) S=Stop MyHome login |
string |
None. |
| mobile | string |
None. |
|
| string |
None. |
||
| customerAuthRefList | Collection of CustomerAuthRef |
None. |
Request Formats
application/json, text/json
Sample:
{
"customerAuthRefList": [
{
"authMethode": "sample string 1",
"authUserType": "sample string 2",
"authUserName": "sample string 3",
"authExternalRef": "sample string 4",
"authVerified": "2025-12-12T02:14:47.7926658+01:00",
"authValidUntil": "2025-12-12T02:14:47.7926658+01:00",
"authSynced": "2025-12-12T02:14:47.7926658+01:00"
},
{
"authMethode": "sample string 1",
"authUserType": "sample string 2",
"authUserName": "sample string 3",
"authExternalRef": "sample string 4",
"authVerified": "2025-12-12T02:14:47.7926658+01:00",
"authValidUntil": "2025-12-12T02:14:47.7926658+01:00",
"authSynced": "2025-12-12T02:14:47.7926658+01:00"
}
],
"isLoginOnBehalfOf": 0,
"isMyHomeAdminUser": 0,
"dataSource": 0,
"partnerName": "sample string 1",
"customerIdApi": "sample string 2",
"customerIdSource": "sample string 3",
"GuidLogin": "758e588c-2a2a-485e-a36e-e954f75d844e",
"GuidLoginRef": "9f9c3cbb-a4b2-4ab8-a515-771c66289049",
"customerRules": "sample string 4",
"mobile": "sample string 5",
"email": "sample string 6"
}
application/xml, text/xml
Sample:
<CustomerKeysAndAuth xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HeimModelCustomerApi">
<GuidLogin>758e588c-2a2a-485e-a36e-e954f75d844e</GuidLogin>
<GuidLoginRef>9f9c3cbb-a4b2-4ab8-a515-771c66289049</GuidLoginRef>
<customerIdApi>sample string 2</customerIdApi>
<customerIdSource>sample string 3</customerIdSource>
<customerRules>sample string 4</customerRules>
<dataSource>Unknown</dataSource>
<email>sample string 6</email>
<mobile>sample string 5</mobile>
<partnerName>sample string 1</partnerName>
<customerAuthRefList>
<CustomerAuthRef>
<authExternalRef>sample string 4</authExternalRef>
<authMethode>sample string 1</authMethode>
<authSynced>2025-12-12T02:14:47.7926658+01:00</authSynced>
<authUserName>sample string 3</authUserName>
<authUserType>sample string 2</authUserType>
<authValidUntil>2025-12-12T02:14:47.7926658+01:00</authValidUntil>
<authVerified>2025-12-12T02:14:47.7926658+01:00</authVerified>
</CustomerAuthRef>
<CustomerAuthRef>
<authExternalRef>sample string 4</authExternalRef>
<authMethode>sample string 1</authMethode>
<authSynced>2025-12-12T02:14:47.7926658+01:00</authSynced>
<authUserName>sample string 3</authUserName>
<authUserType>sample string 2</authUserType>
<authValidUntil>2025-12-12T02:14:47.7926658+01:00</authValidUntil>
<authVerified>2025-12-12T02:14:47.7926658+01:00</authVerified>
</CustomerAuthRef>
</customerAuthRefList>
<isLoginOnBehalfOf>Unknown</isLoginOnBehalfOf>
<isMyHomeAdminUser>Unknown</isMyHomeAdminUser>
</CustomerKeysAndAuth>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |