POST BiometricsLogin
Request Information
URI Parameters
None.
Body Parameters
BiometricsLoginRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
None. |
|
| Metadata | Object |
None. |
|
| Portrait | string |
None. |
|
| Token | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Metadata": {},
"Portrait": "sample string 3",
"Token": "sample string 4"
}
application/xml, text/xml
Sample:
<BiometricsLoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AfiswitchCIOD.Models"> <Token>sample string 4</Token> <Metadata /> <Portrait>sample string 3</Portrait> <Username>sample string 1</Username> </BiometricsLoginRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LoginResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Token | string |
None. |
|
| UserDetails | User |
None. |
|
| TermsAndConditions | Collection of string |
None. |
|
| Response | Response |
None. |
Response Formats
application/json, text/json
Sample:
{
"Token": "sample string 1",
"UserDetails": {
"Id": 1,
"FirstName": "sample string 2",
"Surname": "sample string 3",
"FullName": "sample string 4",
"DisplayName": "sample string 5",
"InstitutionID": 6,
"CompanyName": "sample string 7",
"IsCIODMobileUser": true,
"IsCIODMobileInstitution": true,
"HasPortrait": true,
"MatchedSearchReference": 11,
"Reference": 12,
"InstitutionReference": 13,
"UserIdentifier": "sample string 14",
"Name": "sample string 15",
"GenderID": 64,
"Gender": "sample string 17",
"PopulationGroupID": 64,
"PopulationGroup": "sample string 19",
"EmailAddress1": "sample string 20",
"ContactNumber1": "sample string 21",
"PhysicalAddress1": "sample string 22",
"PhysicalCity": "sample string 23",
"CommentLetter": {
"ID": 1,
"ReviewUserID": 2,
"ReferredUserID": 3,
"ReasonID": 4,
"ReasonDescription": "sample string 5",
"ReferralDate": "2026-04-14T07:20:28.9556672+02:00",
"Comment": "sample string 7",
"Logs": [
{
"MatchReference": 1,
"UserID": 2,
"ReasonID": 3,
"RequestLogID": 4,
"Comment": "sample string 5",
"StatusID": 6,
"FraundStatusID": 7,
"ID": 8,
"SourceReference": 9,
"MatchedReference": 10,
"Username": "sample string 11",
"Status": "sample string 12",
"isMainApplicant": true,
"ReferralDate": "2026-04-14T07:20:28.9556672+02:00",
"Reason": "sample string 15"
},
{
"MatchReference": 1,
"UserID": 2,
"ReasonID": 3,
"RequestLogID": 4,
"Comment": "sample string 5",
"StatusID": 6,
"FraundStatusID": 7,
"ID": 8,
"SourceReference": 9,
"MatchedReference": 10,
"Username": "sample string 11",
"Status": "sample string 12",
"isMainApplicant": true,
"ReferralDate": "2026-04-14T07:20:28.9556672+02:00",
"Reason": "sample string 15"
}
]
}
},
"TermsAndConditions": [
"sample string 1",
"sample string 2"
],
"Response": {
"ResponseCode": 1,
"ResponseMessage": "sample string 2"
}
}
application/xml, text/xml
Sample:
<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AfiswitchCIOD.Models">
<Response>
<ResponseCode>1</ResponseCode>
<ResponseMessage>sample string 2</ResponseMessage>
</Response>
<TermsAndConditions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</TermsAndConditions>
<Token>sample string 1</Token>
<UserDetails>
<CommentLetter>
<Comment>sample string 7</Comment>
<ID>1</ID>
<Logs>
<RecordApprovalModel>
<Comment>sample string 5</Comment>
<FraundStatusID>7</FraundStatusID>
<ID>8</ID>
<MatchReference>1</MatchReference>
<MatchedReference>10</MatchedReference>
<Reason>sample string 15</Reason>
<ReasonID>3</ReasonID>
<ReferralDate>2026-04-14T07:20:28.9556672+02:00</ReferralDate>
<RequestLogID>4</RequestLogID>
<SourceReference>9</SourceReference>
<Status>sample string 12</Status>
<StatusID>6</StatusID>
<UserID>2</UserID>
<Username>sample string 11</Username>
<isMainApplicant>true</isMainApplicant>
</RecordApprovalModel>
<RecordApprovalModel>
<Comment>sample string 5</Comment>
<FraundStatusID>7</FraundStatusID>
<ID>8</ID>
<MatchReference>1</MatchReference>
<MatchedReference>10</MatchedReference>
<Reason>sample string 15</Reason>
<ReasonID>3</ReasonID>
<ReferralDate>2026-04-14T07:20:28.9556672+02:00</ReferralDate>
<RequestLogID>4</RequestLogID>
<SourceReference>9</SourceReference>
<Status>sample string 12</Status>
<StatusID>6</StatusID>
<UserID>2</UserID>
<Username>sample string 11</Username>
<isMainApplicant>true</isMainApplicant>
</RecordApprovalModel>
</Logs>
<ReasonDescription>sample string 5</ReasonDescription>
<ReasonID>4</ReasonID>
<ReferralDate>2026-04-14T07:20:28.9556672+02:00</ReferralDate>
<ReferredUserID>3</ReferredUserID>
<ReviewUserID>2</ReviewUserID>
</CommentLetter>
<CompanyName>sample string 7</CompanyName>
<ContactNumber1>sample string 21</ContactNumber1>
<DisplayName>sample string 5</DisplayName>
<EmailAddress1>sample string 20</EmailAddress1>
<FirstName>sample string 2</FirstName>
<FullName>sample string 4</FullName>
<Gender>sample string 17</Gender>
<GenderID>64</GenderID>
<HasPortrait>true</HasPortrait>
<Id>1</Id>
<InstitutionID>6</InstitutionID>
<InstitutionReference>13</InstitutionReference>
<IsCIODMobileInstitution>true</IsCIODMobileInstitution>
<IsCIODMobileUser>true</IsCIODMobileUser>
<MatchedSearchReference>11</MatchedSearchReference>
<Name>sample string 15</Name>
<PhysicalAddress1>sample string 22</PhysicalAddress1>
<PhysicalCity>sample string 23</PhysicalCity>
<PopulationGroup>sample string 19</PopulationGroup>
<PopulationGroupID>64</PopulationGroupID>
<Reference>12</Reference>
<Surname>sample string 3</Surname>
<UserIdentifier>sample string 14</UserIdentifier>
</UserDetails>
</LoginResponse>