Skip to main content
POST

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Body

application/json

Use the Reveal operation to display card data stored in your vault within Payrails secure and compliant iframe.

type
enum<string>
required

The type of client side elements that you need a configuration for reveal. Reveal allows you to securely display record fields stored in Payrails Vault, e.g. card data. This feature is only available by request and requires an approval by Payrails.

Available options:
reveal
auditData
string
required

Data required for an audit trail related to the request to display the fields. E.g. user ID, who requested to display data, reason, etc.

record
By ID. · object
required

Response

OK. Configurations to initialize Payrails SDK on your client.

version
string
required

The SDK version these configurations are compatible with.

data
string<byte>
required

Configurations to initialize the client SDK.

Last modified on October 5, 2026