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

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

Requires: Transactions.ScreeningProviderConfiguration.ViewSchema, merchant scope.

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

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 . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

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

PowerShell

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

pip install winkpg-api

Python (SDK)

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")

pip install requests

Python (raw HTTP)

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()

Parameters

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

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.