# ScreeningProviderProfileDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

An external screening provider configured for a merchant: which provider is consulted and the
per-merchant credentials and options it needs.

## Fields
- `screeningProviderProfileId` (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.
- `merchantId` (string(uuid)): The owning merchant. Stamped by the server; a value supplied on input is overwritten.
- `isActive` (boolean): Whether this profile is consulted. Only an active profile participates in the exclusivity rule  against the merchant's active processor profiles.
- `configuration` ([MerchantScreeningProviderConfigurationDto](https://devportal.demo.winkpg.io/docs/api/models/MerchantScreeningProviderConfigurationDto.md)) required: The provider identity and its per-merchant field values.
  Fields:
  - `providerId` (string): Identifier of the screening provider, matching a provider returned by the screening provider  discovery endpoint. Required. (nullable)
  - `providerName` (string): Display name of the provider. Optional on input; the server backfills it from the registered  provider configuration. (nullable)
  - `fieldValues` (array<[ProcessorFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/ProcessorFieldValueDto.md)>): 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)
- `reviewAction` ([ScreeningReviewAction](https://devportal.demo.winkpg.io/docs/api/models/ScreeningReviewAction.md)): 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:
  - `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.
- `onFailureBehavior` ([ScreeningFailureBehavior](https://devportal.demo.winkpg.io/docs/api/models/ScreeningFailureBehavior.md)): 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:
  - `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.
- `timeoutMs` (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`. (nullable, min 250, max 30000)
- `reviewHoldDeadlineMinutes` (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. (nullable, min 15, max 43200)
- `reviewHoldExpiryAction` ([ReviewHoldExpiryAction](https://devportal.demo.winkpg.io/docs/api/models/ReviewHoldExpiryAction.md)): 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:
  - `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.

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.