DocumentationID Check DE Bravo
Compatible Cases
About the service
ID Check DE Bravo is an identity verification service for Germany.
Product Code: W2-DATA-EKYC-DE-012
Does this service leave a credit search Footprint? Yes
Request
The following request properties pertain to this service.
| Property Name | Type | Length | Optional/Mandatory | Notes |
|---|---|---|---|---|
| Forename | String | 30 | Mandatory | Can contain multiple forenames (separated by a space) if appropriate |
| MiddleNames | String | 15 | Optional | |
| Surname | String | 30 | Mandatory | |
| DayOfBirth | Integer | 2 | Day, month and year birth components must all have a value, or all be null. | |
| MonthOfBirth | Integer | 2 | Day, month and year birth components must all have a value, or all be null. | |
| YearOfBirth | Integer | 4 | Day, month and year birth components must all have a value, or all be null. | |
| HouseName | String | 26 | Optional | |
| HouseNumber | String | 26 | Optional | |
| Street | String | 255 | Mandatory | |
| City | String | 100 | Mandatory | |
| Postcode | String | 8 | Mandatory | This must be four numeric digits. e.g. "1219" |
| PhoneNumber | String | Optional | ||
| MobileNumber | String | Optional | ||
| Gender | String | Optional | Must be 'M' or 'F' |
After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation returned for the service call.
Response
Example response
"idCheckDEBravoResult": {
"addressMatchResultType": "MATCH",
"referenceNumber": "4086000153992802"
}Response breakdown
The following table gives some more details about the response.
| Property Name | Type | Description |
|---|---|---|
| AddressMatchResultType | String | Result on whether an address match has been found. |
| ReferenceNumber | String | A reference number for the check. |
Notes
AddressMatchType Represents the type of match.
| Value | Description |
|---|---|
| MATCH | A Match can be found. |
| CANDIDATES | Partial matches have been found. |
Sandbox
To use sandbox the following example request can be used.
Remember to include the W2 provided API key in the Authorization Header.
Example request
{
"Bundle": "KYC_DE_012",
"Data": {
"Forename": "Michael",
"Surname": "Tschank",
"HouseNumber": "51",
"Street": "Nobilegasse",
"City":"Wien",
"Postcode": "1150"
},
"Options": {
"Sandbox": "true"
},
"ClientReference": "your-client-reference"
}Sandbox Cases
Single match
If the following details are set, a single fictitious match is returned in IDCheckDEBravoResult
| Property | Value |
|---|---|
| City: | "FRANKFURT" |
| DayOfBirth: | "12" |
| Forename: | "HEIKO" |
| HouseNumber: | "15" |
| MonthOfBirth: | 07 |
| Postcode: | "60325" |
| Street: | "SCHUMANNSTR" |
| Surname: | "GRASSMANN" |
| YearOfBirth: | 1985 |
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceTransactionResult: | Success |
| ServiceInterpretResult: | Pass |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | Pass |
No-match
Anything else returns a no-match result.
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceTransactionResult: | Success |
| ServiceInterpretResult: | Inconclusive |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | Pass |