Skip to main content
POST
Create a PRO credential set
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /pro-credentials Description: Creates a new credential set for a (tenant, society) pair. One active set per society per tenant — fails if credentials for the given societyCode already exist for this tenant (regardless of isActive… the pre-create check is not scoped to active-only). credentials is encrypted at rest before the row is written; the response never echoes it back. Authorization:
  • Required role: admin or higher
  • Requires an active publisher addon
Method: POST

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
societyCode
string
required
Required string length: 2 - 3
Example:

"BMI"

accountId
string
required
submissionMethod
enum<string>
required
Available options:
SFTP,
API,
EMAIL
credentials
object
required

Write-only credential payload. Fields used depend on submissionMethod; unused fields are ignored.

Example:
societyName
string | null
endpointConfig
object
isActive
boolean
default:true

Response

Credential set created

status
string
Example:

"success"

data
object

Serialized row — never includes the credential payload (see the tag description).