IdExchange API Guide
The IdExchange API provides and an efficient, robust and secure way for enables application developers to connect their applications for IdExchange ID proofing and credentialing services. For performance and mobile-friendly development, the API is based on representational state transfer (REST) and facilitates the transmissions of objects via JavaScript object notation (JSON). The guide below provides examples for interacting with the IdExchange API for common transactions.
Security
Each client must have a valid client certificate and be the capability of performing mutual authentication with the IdExchange server. The certificate thumbprint will also be registered within the IdExchange system in order to provide role-based access.
Connecting to the API
| Step Number | Procedure |
|---|---|
| 1 | Generate and install the certificate. |
| 2 | Email the certificate to the IdExchange system administrator. |
| 3 | The certificate will be enrolled and the role assigned. |
Performing a general search for a user.
This API allows an operator to locate a set of users based on a specific criteria. For example, if the operator wanted to search for all users with the last name begging with the letter R, the operator would execute the search query below:
https://idexchange.cyberarmed.com/WebApi/api/users?searchCriteria=searchValue where searchValue is the last name
For example, to search for users with the last name of r, the use this:
https://idexchange.cyberarmed.com/WebApi/api/users?searchCriteria=r
which will return the following JSON content:
[{"userId":1000000086,"lastName":"Reese","firstName":"Monica","emailAddress":"Testemail@test.com","organizationAffiliation":"11903","employmentStatus":"Active"},{"userId":1000000087,"lastName":"Reese","firstName":"Stephanie","emailAddress":"Testemail@test.com","organizationAffiliation":"11903","employmentStatus":"Active"},{"userId":1000000088,"lastName":"Roberts","firstName":"Stephanie","emailAddress":"Testemail@test.com","organizationAffiliation":"11903","employmentStatus":"Active"},{"userId":1000000089,"lastName":"Roberts","firstName":"Stephanie","emailAddress":"Testemail@test.com","organizationAffiliation":"11903","employmentStatus":"Active"},{"userId":1000000090,"lastName":"Roberts","firstName":"Stephanie","emailAddress":"Testemail@test.com","organizationAffiliation":"11903","employmentStatus":"Active"}]
Submitting biometric data for a user
The IdExchange API also allows applications to submit user biometric data. The following detailed provides the interface for submitting biometric data via the API.
Request Format
