For AI agents: a documentation index is available at /llms.txt. A markdown version of this page is available at /guide/api/endpoints/developer/validate.md.

APIEndpointsDeveloper

Validate developer API authentication

Confirms your API key and payload encryption work.

POST/api/v1/partner/validate

Confirms your API key and payload encryption work. Send any small JSON object encrypted as encrypted_data; the server decrypts it with your key's secret and echoes it back in data. Touches no records.

#Authorizations

X-API-KEYstringrequired

Developer API key (starts with osk_)

Example: osk_1234567890abcdef1234567890abcdef

#Request body

The encrypted_data field is required. Encrypt any small JSON object, for example one with a single ping field.

encrypted_datastringrequired

Base64 of the 16-byte IV followed by the AES-256-CBC ciphertext of your JSON payload

#Responses

200Key valid and payload decrypted
json
{
  "success": true,
  "message": "Request validated successfully",
  "data": {
    "ping": "hello"
  }
}
401Missing or invalid API key, or a payload that does not decrypt
422encrypted_data missing
json
{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "encrypted_data": [
      "The encrypted data field is required."
    ]
  }
}