This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-11-12 05:58 UTC.
Example body:
```
{
"isActive": true,
"configuration": {
"providerId": "example-screening",
"fieldValues": [ { "key": "apiKey", "value": "…" } ]
}
}
```
An active profile whose provider declares a conflict with one of the merchant's active processor
profiles is rejected. Optionally send `If-Match: "<concurrencyStamp>"` for optimistic
concurrency (409 on a stale stamp).
Signed in, you can send this request to your own sandbox merchant from the console
and read the answer.
Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a ScreeningProviderProfileDto. See the Request body section below for its fields.
Parameters
Name
In
Type
Description
idrequired
path
string (uuid)
The merchant id.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
suppressNullsrequired
query
boolean
If true, omit properties with null values.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Request body
application/json, required
Field
Type
Description
screeningProviderProfileIdrequired
string (uuid)
Unique identifier of this screening provider profile. Server-assigned on add; any value supplied
on input to the sub-resource surface is ignored.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
merchantIdrequired
string (uuid)
The owning merchant. Stamped by the server; a value supplied on input is overwritten.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isActiverequired
boolean
Whether this profile is consulted. Only an active profile participates in the exclusivity rule
against the merchant's active processor profiles.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Values for the provider's configuration fields, keyed by field definition key. Values for fields
the provider marks secret are encrypted at rest and are decrypted only for an authorized
merchant read.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
What the platform does when this provider asks for a human decision rather than answering
accept or decline. Omit (or send `null`) for the default,
`Audit`: record the verdict on the transaction and continue.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Audit
Record the review verdict on the transaction and continue to authorization. The default.
Stop
Treat the review verdict as a rejection: halt the flow before authorization, exactly as a provider decline does.
HoldForReview
Park the transaction before authorization and wait for a reviewer to dispose of it, rather than deciding the sale on the provider's behalf in either direction.
What the platform does when this provider cannot give a decision at all: a timeout, an error, an
Unavailable verdict, or a skipped call because the provider's circuit breaker is open. Omit (or
send `null`) for the default,
`ContinueWithAudit`: record the non-decision on the
transaction and continue to authorization.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
ContinueWithAudit
Record the non-decision on the transaction and continue to authorization. The default.
HardStop
Halt the transaction before authorization, with a client-safe error saying screening was unavailable. Deliberately distinct from a provider decline: nothing has judged the transaction risky, the platform simply could not ask.
timeoutMsrequired
integer (int32)
How long one call to this provider may take before it is abandoned and recorded as a timeout, in
milliseconds. Accepted range is `MinimumMs` to
`MaximumMs`; omit for the default,
`DefaultMs`.nullablemin 250max 30000
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
reviewHoldDeadlineMinutesrequired
integer (int32)
How long a transaction held for manual review may wait for a reviewer's disposition, in minutes.
Accepted range is `MinimumDeadlineMinutes` to
`MaximumDeadlineMinutes`; omit for the default,
`DefaultDeadlineMinutes`.
Conditional: When ReviewAction != HoldForReview.nullablemin 15max 43200
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
What happens to a held transaction whose deadline elapsed with no reviewer disposition. Omit (or
send `null`) for the default,
`Decline`: an
unanswered review is not an approval.
Conditional: When ReviewAction != HoldForReview.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Decline
Decline the held transaction when the deadline passes, exactly as a reviewer rejection would. The default.
ApproveAndContinue
Release the held transaction to authorization when the deadline passes, recording that it was approved by expiry rather than by a reviewer.
This request body has no documented fields.
Responses
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.