# POST /api/screening-providers/{providerId}/validate-config

Dry-run validates a screening provider configuration payload without writing a merchant document.

**Required permissions**: `Transactions.ScreeningProviderConfiguration.ViewSchema`  
**Scope**: merchant

**Operation ID:** `POST_api_screening-providers_providerId_validate-config`

## Authorization

Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.

Required permissions:
- `Transactions.ScreeningProviderConfiguration.ViewSchema`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| providerId | path | yes | string | The provider identifier. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The profile to validate.

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

Schema: `PhoeniXGateMerchantsScreeningProviderProfileDto`

**Content type:** `text/json`

Schema: `PhoeniXGateMerchantsScreeningProviderProfileDto`

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

Schema: `PhoeniXGateMerchantsScreeningProviderProfileDto`

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateTransactionsProcessorProfileProcessorConfigValidationResultDto`

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

Schema: `PhoeniXGateTransactionsProcessorProfileProcessorConfigValidationResultDto`

**Content type:** `text/json`

Schema: `PhoeniXGateTransactionsProcessorProfileProcessorConfigValidationResultDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

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