# GET /api/screening-providers/{providerId}/config-schema/template

Returns a ready-to-fill screening provider profile skeleton.

Suitable for dropping into `processing.screeningProviderProfiles[]` on a merchant
create or update.

**Operation ID:** `screeningProviderMetadataGetConfigTemplate`

## Authorization

Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Transactions.ScreeningProviderConfiguration.ViewSchema`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| providerId | path | yes | string | The provider identifier. |
| includeOptional | query | no | boolean | When false (default), only required and defaulted fields are emitted; when true, all fields are. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`ScreeningProviderProfileDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ScreeningProviderProfileDto.md)

Properties:
- `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.signapay-sbx.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.signapay-sbx.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.signapay-sbx.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.signapay-sbx.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.signapay-sbx.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.

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": null,
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 401

Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 403

Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 404

Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": null,
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": null,
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": null
  }
}
```

### 500

Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 501

Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": null,
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": null
  }
}
```

### Errors

These statuses answer with the error envelope outlined below.

- `400`: Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
- `401`: Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
- `403`: Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
- `404`: Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
- `500`: Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
- `501`: Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
- `default`: The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))
  Fields:
  - `code` (string): (nullable)
  - `message` (string): (nullable)
  - `details` (string): (nullable)
  - `data` (object): (nullable)
  - `validationErrors` (array<[RemoteServiceValidationErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceValidationErrorInfo.md)>): (nullable)

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": null,
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

## Authentication

- `ApiKey`

## 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.

### cURL

```bash
curl -X GET "{{BASE_URL}}/api/screening-providers/{providerId}/config-schema/template" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/screening-providers/{providerId}/config-schema/template' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, ScreeningProviderMetadataApi } from '@winkpg/winkpg-api';

const api = new ScreeningProviderMetadataApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.screeningProviderMetadataGetConfigTemplate("PROVIDER_ID");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/screening-providers/{providerId}/config-schema/template', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new ScreeningProviderMetadataApi(config);
var result = await api.ScreeningProviderMetadataGetConfigTemplateAsync("PROVIDER_ID");
```

### C# (raw HTTP)

```csharp
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/screening-providers/{providerId}/config-schema/template");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.ScreeningProviderMetadataApi(client)
    result = api.screening_provider_metadata_get_config_template("PROVIDER_ID")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/screening-providers/{providerId}/config-schema/template",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

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