Accessing the RapID service

Your web server needs to access the RapID Service to request new or replacement credentials for your end-users. This can be done in one of two ways:

Using the RESTful Web API

You can choose to interface directly with our RESTful endpoint. This is located at

For example, in order to request a new credential you would need to perform a POST to the endpoint, along with the following JSON body.


The JSON response that you would receive if successful would be as below.

    "AnonId":"<As supplied in your request>",

To authenticate the connection, the POST must be over two way TLS using the certificate that you downloaded from your RapID customer portal dashboard. If this is not setup correctly, or the request body is not valid, you will receive the appropriate HTTP status code.

For details, see the Web API documentation.

Using a RapID Server SDK

Alternatively, you can use one of the RapID Server SDKs. To support various platforms, we provide three server SDKs.

For example, in order to request a new credential you would use the appropriate SDK's RequestIdentity method:

Platform Request sample
C# RequestIdentity("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
PHP requestIdentity("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
Ruby request_identity("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

For details, see the Server SDKs documentation.