Generate a client certificate

post/companies/{companyId}/clientCertificates

Generates a client certificate for secure communication with Adyen using mutual TLS (mTLS). Provide a certificate signing request (CSR). Adyen signs it and returns the client certificate.

The CSR must be generated by a key pair that meets the following criteria:

Key ownership: the CSR must be signed by the associated private key.
Key type: RSA with a minimum key size of 2048 bits, or ECC with a minimum key size of 224 bits.

A company account can have a maximum of 10 valid client certificates at a time.

The subject distinguished name (subjectDN) of the issued certificate is constructed by Adyen from the path companyId and the request apiCredential. The subject in your CSR is not used. The returned subjectDN has the format UID={apiCredential}-Company.{companyId},CN={apiCredential}-Company.{companyId},O=Company.{companyId}.

To make this request, your API credential must have the following roles:

Management API - Client certificates read and write

Endpoint destination URL

https://management-test.adyen.com/v3/companies/{companyId}/clientCertificates

Path Parameters

Required

Optional

Min length: 1

Request Parameters

Required

Optional

Min length: 1

The API Credential that you want to use this certificate with, in the format 'ws_@Company.'. NOTE: You must assign the DN on that specified API credential with the one from the generated client certificate. Accomplish this either through the Customer Area API Credential page or the PATCH endpoint for apiCredentials

Min length: 1

Certificate signing request. Must be a Base64-encoded DER string. Only the public key is enrolled; see the enroll operation for subject handling.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

201 - Created
Client certificate was generated successfully.
caChainarray[string]
Certificate chain with intermediates and Management Certificate Authority Root which excludes the signed client certificate leaf
idstring
Min length: 1
The unique identifier of the client certificate
leafstring
Signed client certificate as a Base64-encoded DER string
serialNumberstring
Min length: 1
Serial number of client certificate
subjectDNstring
Min length: 1
Subject DN (Distinguished Name) of client certificate. Server-generated from companyId and apiCredential; see the enroll operation for details.
400 - Bad Request
The provided CSR is malformed or of an incorrect format.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized
The API credential used in the request is invalid.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error: missing or invalid request fields, a certificate signing request that does not meet our requirements, or the company has reached its limit of 10 client certificates.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
429 - Too Many Requests
Request rate limit exceeded.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error
An unrecoverable error occurred while trying to perform the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Generate a client certificate

HTTP Responses

201 - Created

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

429 - Too Many Requests

500 - Internal Server Error