POST api/bfg/v1/persons/validate-pin
Validate a person's pin
Request Information
URI Parameters
None.
Body Parameters
ValidatePinRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PersonID | integer |
Required |
|
| BrandID | integer |
Required |
|
| Pin | string |
Required String length: inclusive between 0 and 10 |
|
| IpAddress | string |
String length: inclusive between 0 and 45 |
Request Formats
application/json, text/json
Sample:
{
"PersonID": 1,
"BrandID": 2,
"Pin": "sample string 3",
"IpAddress": "sample string 4"
}
application/xml, text/xml
Sample:
<ValidatePinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Person"> <BrandID>2</BrandID> <IpAddress>sample string 4</IpAddress> <PersonID>1</PersonID> <Pin>sample string 3</Pin> </ValidatePinRequest>
Response Information
Resource Description
Result of pin validation
ValidatePinResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| Message | string |
None. |
|
| RemainingAttempts | integer |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.