X.509 client certificates

Listing Certificates

To list the X.509 client certificates associated with a specific user, API clients can send an HTTP GET request to the following sub-resource:

/users/{user-id}/certificates

Here, {user-id} is the unique identifier assigned by Verifalia when the user was created, also included when listing or retrieving users.

If the request is successful, Verifalia responds with an HTTP 200 (OK) status code and returns a JSON object containing an array of certificate details for the specified user. If the request fails, the API returns an appropriate HTTP error status code and, where applicable, details about the error.

Certificate detail structure

The response follows Verifalia’s standard paginated results format. Each item in the data array represents a single X.509 client certificate and includes the following fields:

Uploading and binding certificates

To upload and bind an X.509 client certificate to a specific user, API clients should send an HTTP POST request to the following sub-resource:

/users/{user-id}/certificates

Here, {user-id} is the unique identifier assigned by Verifalia when the user is created, also included when listing or retrieving users. The request must use the multipart/form-data content type and include the client certificate file in the form field named certificate.

Supported certificate file formats are:

• Base64-encoded format (commonly with .pem, .crt, or .cer extensions);
• Binary (DER) format (commonly with .der or .cer extensions).

If the certificate is successfully uploaded and bound, Verifalia responds with an HTTP 200 (OK) status code and returns a JSON object describing the newly added certificate, following the structure outlined in the certificate detail structure section.

If the operation fails, the API returns a relevant HTTP error status code along with problem details, if available.

Deleting Certificates

To delete a client certificate, API clients should send an HTTP DELETE request to the following sub-resource:

/users/{user-id}/certificates/{certificate-id}

Here, {user-id} is the unique identifier assigned by Verifalia when the user is created while {certificate-id} is the unique identifier assigned by Verifalia when the certificate is uploaded.

If the deletion is successful, Verifalia responds with an HTTP 200 (OK) status code. If the request fails, the API returns an appropriate HTTP error status code and, when applicable, details about the issue. Once deleted, the certificate can no longer be used to authenticate with the Verifalia API.