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
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
companyId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
apiCredential |
String | Yes |
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 |
certificateSigningRequest |
String | Yes |
Certificate signing request. Must be a Base64-encoded DER string. Only the public key is enrolled; see the enroll operation for subject handling. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.