POST api/BOProfile/VerifyIdentity

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Flag	integer	None.
DocumentType	string	None.
FirstName	string	None.
LastName	string	None.
PhoneNumber	string	None.
IdentityImageUrl	string	None.
FaceIdPic	string	None.
DOB	date	None.
issueDate	date	None.
expiryDate	date	None.
NinId	string	None.
IdentityLocation	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Flag": 1,
  "DocumentType": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "PhoneNumber": "sample string 6",
  "IdentityImageUrl": "sample string 7",
  "FaceIdPic": "sample string 8",
  "DOB": "2025-04-04T06:41:32.3771219+01:00",
  "issueDate": "2025-04-04T06:41:32.3771219+01:00",
  "expiryDate": "2025-04-04T06:41:32.3771219+01:00",
  "NinId": "sample string 14",
  "IdentityLocation": "sample string 17"
}

application/xml, text/xml

Sample:

<AddVerifiedIdentityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <AttemptNumber>10</AttemptNumber>
  <BusinessName>sample string 11</BusinessName>
  <Country>sample string 5</Country>
  <DOB>2025-04-04T06:41:32.3771219+01:00</DOB>
  <Details>sample string 20</Details>
  <DocumentType>sample string 2</DocumentType>
  <EmailId>sample string 9</EmailId>
  <Err>18</Err>
  <FaceIdPic>sample string 8</FaceIdPic>
  <FirstName>sample string 3</FirstName>
  <Flag>1</Flag>
  <IdentityImageUrl>sample string 7</IdentityImageUrl>
  <IdentityLocation>sample string 17</IdentityLocation>
  <IsVerified>sample string 12</IsVerified>
  <LastName>sample string 4</LastName>
  <NinId>sample string 14</NinId>
  <PhoneNumber>sample string 6</PhoneNumber>
  <ServiceName>sample string 13</ServiceName>
  <Source>sample string 19</Source>
  <UserId>16</UserId>
  <businessId>15</businessId>
  <expiryDate>2025-04-04T06:41:32.3771219+01:00</expiryDate>
  <issueDate>2025-04-04T06:41:32.3771219+01:00</issueDate>
</AddVerifiedIdentityModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddVerifiedIdentityModel'.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/04 06:41:32",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>