get_certificate_signing_request
Generate a PKCS #10 CSR for an APC-held asymmetric key so an external CA can issue a certificate for it. The private key remains in the HSM; only the CSR is exported.
Instructions
Call this to get a PKCS #10 CSR for an APC-held asymmetric key, so an external CA (or a partner's PKI) can issue a certificate for it. This is the APC counterpart of the payShield/Futurex "generate certificate request" commands — Futurex RSAR, for instance, is a PKCS #10 CSR generator.
The private key stays in APC's HSMs; only the CSR leaves. Typical use is TR-34 key distribution or ECDH key exchange, where the counterparty must trust an APC key.
Args: key_identifier: ARN or alias of the asymmetric key (RSA or ECC) to request a certificate for signing_algorithm: Hash used to sign the CSR — SHA224, SHA256, SHA384, or SHA512 certificate_subject: X.509 subject. CommonName is required; OrganizationUnit, Organization, City, Country, StateOrProvince and EmailAddress are optional: {"CommonName": "acquirer-tr34-2026", "Organization": "Example Bank", "Country": "US"}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key_identifier | Yes | ||
| signing_algorithm | Yes | ||
| certificate_subject | Yes |