Profile
Manage the profiles of the organization's customers
| API | Description |
|---|---|
| PUT api/Profile/Validate |
The first method in the new profile enrollment process, check that all the signatures in the profile are consistent enough. Always make sure that the profile is valid before calling the 'Enroll' method. When not valid the 'ProfileValidation' result will sugest which index in the signatures array to replace with more consistent signature before re-checking the profile validation |
| POST api/Profile/Enroll |
Enroll a new customer profile. Always call this method only after the profile has confirm valid with the 'Validate' method, or exception will be thrown. |
| PUT api/Profile/Verify/{profileGuid}/{threshold} |
Verify (authenticate) a given customer signature against an existing profile |
| PUT api/Profile/Deactivate/{profileGuid} |
Deactivate a certain profile, no verification can be done against it while in this state. |
| PUT api/Profile/Reactivate/{profileGuid} |
Reactivate a profile that is in 'Deactivate' (by command) state or in 'Suspended' (by the server) state. |
| PUT api/Profile/Erase/{profileGuid} |
No documentation available. |
| PUT api/Profile/SetVerificationThreshold/{profileGuid}/{threshold} |
Set the Verification Threshold value for a certain profile. All futures verifications for this profile will be done with his specific threshold value. |
| PUT api/Profile/Status/{profileGuid} |
Check for the profile status, to make sure it's ready for verificatiob before collecting the signature from the customer. |
Organization
Manage the organization password and settings
| API | Description |
|---|---|
| POST api/Organization/ChangePassword |
Change the current password, mandatory after the initial registration or password reset by Admin. |
| PUT api/Organization/EnrollmentLevel/{enrollmentLevel} |
Change the Enrollment Level (the resemblance required between the signatures in the profile) for your organization. When not set, the general server settings will be used. |
| GET api/Organization/EnrollmentLevel |
Get the Enrollment Level (the resemblance required between the signatures in the profile) value for your organization |
| PUT api/Organization/VerificationThreshold/{threshold} |
Change the Verification Threshold (the resemblance required between the signature and a profile to "pass" verification) for your organization. When not set, the general server settings will be used. Verification Threshold given to a specific profile, will override this setting on that profile. |
| GET api/Organization/VerificationThreshold |
Get the Verification Threshold (the resemblance required between the signature and a profile to "pass" verification) for your organization. |
| GET api/Organization/Siblings |
Get the siblings organizations of the organization (siblings can request verification on the main organization profiles) |
AdminApi
Manage the organizations using the BioServer system (system admin only)
| API | Description |
|---|---|
| POST api/Admin/CreateNewOrganization |
Create new organization |
| POST api/Admin/ResetPassword/{loginCode} |
Reset password for a certain organization, the password will be reset to Ab123456# and the organization must change the password before he will be able to use the BioServer system |
| POST api/Admin/Deactivate/{loginCode} |
Deactivate a certain organization. The organization will not be able to use the BioServer system while in this state. |
| POST api/Admin/Reactivate/{loginCode} |
Reactivate an Organization that is in 'Deactivate' (by system admin) state or in 'Suspended' (by the server) state. |
| PUT api/Admin/EnrollmentLevel/{loginCode}/{enrollmentLevel} |
Set the Enrollment Level required for new enrollments for a certain Organization. |
| PUT api/Admin/VerificationThreshold/{loginCode}/{threshold} |
Set the Verification Threshold required for signature verifications for a certain Organization. |
| PUT api/Admin/AllocatedProfiles/{loginCode}/{count} |
Allocate a finite number for profiles for a certain Organization, the organization will not be able to enroll new profiles when this number is maxed out. |
| PUT api/Admin/AllocatedVerifications/{loginCode}/{count} |
Allocate a finite number for verifications for a certain Organization, the organization will be suspended when this number is maxed out. |
| GET api/Admin/Organizations |
Get an array of the registered Organizations to the BioServer system. |
| GET api/Admin/Organization/{loginCode} |
Get a detailed status of a certain Organization |
| POST api/Admin/LoadBattery |
No documentation available. |
| PUT api/Admin/DecodeBattery |
No documentation available. |
| PUT api/Admin/SetSiblings/{loginCode} |
No documentation available. |
Verifications
Access the organization verifications history
| API | Description |
|---|---|
| GET api/Verifications/{profileGuid}?count={count}&date={date} |
Get the last verification results done in your organization |
| GET api/Verifications/RetrieveVerification/{confirmationCode} |
Retrieve the verification result for previous verifications process |
| GET api/Verifications/RetrieveSignature/{confirmationCode} |
Retrieve the signature image (when available) for previous verifications process |
SignaturePadApi
| API | Description |
|---|---|
| GET api/SignaturePad/DisposableToken/{identifier}/{threshold} |
No documentation available. |
| GET api/SignaturePad/EnrollResult/{token} |
No documentation available. |
| GET api/SignaturePad/VerifyResult/{token} |
No documentation available. |
Dashboard
| API | Description |
|---|---|
| GET api/Dashboard/BatteriesStatus |
No documentation available. |
| GET api/Dashboard/AnnualUsage/{loginCode} |
No documentation available. |
| GET api/Dashboard/FilterUsage/{loginCode} |
No documentation available. |
| POST api/Dashboard/VerificationStatistics |
No documentation available. |
| POST api/Dashboard/OrgVerificationStatistics |
No documentation available. |
| POST api/Dashboard/VerificationSpreadsheet1 |
No documentation available. |
| POST api/Dashboard/VerificationSpreadsheet |
No documentation available. |