Skip to main content
POST
The certificate cannot be sent through the POST /credentials route. Certificate fields inside custom_data are rejected with the CERTIFICATE_FIELDS_NOT_ALLOWED error.
string
required
Content of the .pfx / .p12 (PKCS#12) file converted to Base64, on a single line, with no breaks. File must be at most 64 KB.
string
required
Password of the .pfx file. Not the court portal password.
string
System and court where the certificate will be used, for example ESAJ - TJSP - 1º grau. Use * to register it as a wildcard credential.
string
Credential identifier defined by you. If omitted, the default value * is used.
object
Extra credential data. Only send it when the court also requires two-factor authentication.
If a certificate for the same holder already exists in that credential, the message will be CERTIFICATE_UPDATED and the previous certificate is discarded.
Full guide, including converting the file to Base64 and the Postman walkthrough: Credentials Vault — digital certificate.

Authorizations

api-key
string
header
required

API key for authentication

Body

application/json
file_base64
string
required

PFX/P12 file content encoded as a single-line Base64 string

password
string
required

Password of the PKCS#12 file (not the court portal password)

system_name
string

e.g. "ESAJ - TJSP - 1º grau" or * (wildcard)

customer_key
string

Client-defined identifier for the credential. Defaults to *

custom_data
object

Extra credential data. Only required when the court also enforces two-factor authentication.

Response

Certificate created or updated

message
enum<string>
Available options:
CERTIFICATE_CREATED,
CERTIFICATE_UPDATED
customer_key
string
subject_cn
string

Certificate holder (CN)

not_after
string<date-time>

Certificate expiration date

uploaded_at
string<date-time>