Replace a Provider's Instruction Override

PUT

whitelabel

providers

{provider_id}

instructions

Replace a Provider's Instruction Override

curl --request PUT \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "name": "Acme Risk"
}
'

import requests

url = "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions"

payload = {
    "instructions": [{}],
    "setup_instructions": [{}],
    "more_info_url": "https://docs.example.com/stripe",
    "name": "Acme Risk"
}
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    instructions: [{}],
    setup_instructions: [{}],
    more_info_url: 'https://docs.example.com/stripe',
    name: 'Acme Risk'
  })
};

fetch('https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'instructions' => [
        [
                
        ]
    ],
    'setup_instructions' => [
        [
                
        ]
    ],
    'more_info_url' => 'https://docs.example.com/stripe',
    'name' => 'Acme Risk'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "PRIVATE-SECRET-KEY: <api-key>",
    "PUBLIC-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions"

	payload := strings.NewReader("{\n  \"instructions\": [\n    {}\n  ],\n  \"setup_instructions\": [\n    {}\n  ],\n  \"more_info_url\": \"https://docs.example.com/stripe\",\n  \"name\": \"Acme Risk\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": [\n    {}\n  ],\n  \"setup_instructions\": [\n    {}\n  ],\n  \"more_info_url\": \"https://docs.example.com/stripe\",\n  \"name\": \"Acme Risk\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": [\n    {}\n  ],\n  \"setup_instructions\": [\n    {}\n  ],\n  \"more_info_url\": \"https://docs.example.com/stripe\",\n  \"name\": \"Acme Risk\"\n}"

response = http.request(request)
puts response.read_body

{
  "provider_id": "STRIPE",
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "name": "Acme Risk",
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}

{
  "type": "about:blank",
  "title": "Invalid provider instructions",
  "status": 400,
  "detail": "The instruction override was rejected",
  "violations": [
    "name: only Yuno's own providers can be renamed; 'STRIPE' cannot"
  ]
}

{
  "code": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "Request body is too large"
  ]
}

Stores your own connection instructions for this provider, replacing the Yuno catalogue’s wording where you override it.

The document is stored whole, not merged. A field this body omits is cleared, and the provider reverts to the catalogue’s value for it. The safe edit is: read the current document with Retrieve a Provider’s Instruction Override, change the one field, and put the whole thing back.

At least one of instructions, setup_instructions, more_info_url and name must be present. Unknown top-level keys are rejected rather than ignored, and the serialised document may not exceed 64 KB. Overriding a provider’s wording does not add it to your allowlist — editing text never changes what you offer.

Path Parameters

string

required

Yuno catalogue provider id in UPPER_SNAKE_CASE. Case-insensitive — normalized to upper case.

Body

object[]

The connection steps shown to your own users.

Show step

integer

Position of the step.

string | object

The step’s text. Either a plain string or a language map such as {"EN": "...", "ES": "..."}.

string | object

Link label. Same shape rules as text.

string

Target URL. Must be https — the dashboard renders it as an href.

string

Step type.

boolean

Whether this step carries nested steps.

string

Type of the nested steps.

object[]

Nested steps, in the same shape. Up to 3 levels deep.

object[]

Grouped setup steps.

Show group

string

Group heading.

integer

Position of the group.

string

Type of the steps in this group.

object[]

The steps, in the same shape as instructions above.

string

Link to your own documentation for this provider. Must be an https URL.

string

Display name that replaces the catalogue’s. At most 255 characters.Accepted only for Yuno-owned providers — a catalogue id containing YUNO, such as YUNO_3DS or YUNO_FRAUD_SCREENING. Any other provider is rejected with 400.

Response

The stored document, in the same shape as Retrieve a Provider’s Instruction Override, including the read-only created_at, updated_at, created_by and updated_by fields.

curl -X PUT 'https://api.y.uno/v1/whitelabel/providers/STRIPE/instructions' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "more_info_url": "https://docs.example.com/stripe",
    "instructions": [
      {
        "step": 1,
        "text": { "EN": "Open your Stripe dashboard.", "ES": "Abre tu panel de Stripe." },
        "type": "TEXT"
      },
      {
        "step": 2,
        "text": "Copy the secret API key and paste it below.",
        "text_link": "Where do I find my key?",
        "link": "https://docs.example.com/stripe#api-keys",
        "type": "LINK"
      }
    ]
  }'

{
  "provider_id": "STRIPE",
  "more_info_url": "https://docs.example.com/stripe",
  "instructions": [
    {
      "step": 1,
      "text": { "EN": "Open your Stripe dashboard.", "ES": "Abre tu panel de Stripe." },
      "type": "TEXT"
    },
    {
      "step": 2,
      "text": "Copy the secret API key and paste it below.",
      "text_link": "Where do I find my key?",
      "link": "https://docs.example.com/stripe#api-keys",
      "type": "LINK"
    }
  ],
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}

{
  "title": "Invalid provider instructions",
  "status": 400,
  "detail": "The instruction override was rejected",
  "violations": [
    "name: only Yuno's own providers can be renamed; 'STRIPE' cannot"
  ]
}

violations lists every problem with the document at once — fix them together rather than resubmitting to discover the next one.

Errors

HTTP	Envelope	When
`400`	`VALIDATION_ERROR`	`provider_id` is not a valid catalogue id.
`400`	problem+json	The document was rejected: an unknown top-level key, a non-https `link` or `more_info_url`, `name` on a provider that is not Yuno-owned, an empty document, or more than 64 KB.
`401`	`NOT_AUTHENTICATED`	Missing or invalid API keys.
`413`	—	Request body larger than 256 KB.

Authorizations

PUBLIC-API-KEY

string

header

default:<Your PUBLIC-API-KEY>

required

PRIVATE-SECRET-KEY

string

header

default:<Your PRIVATE-SECRET-KEY>

required

Path Parameters

provider_id

string

required

Yuno catalogue provider id in UPPER_SNAKE_CASE. Case-insensitive; normalized to upper case.

Example:

"STRIPE"

Body

application/json

The complete override document.

The complete override document. At least one property must be present.

instructions

object[]

The connection steps shown to your own users. Every link must be https.

setup_instructions

object[]

Grouped setup steps.

more_info_url

string<uri>

Link to your own documentation for this provider. Must be an https URL.

Example:

"https://docs.example.com/stripe"

name

string

Display name that replaces the catalogue's. Accepted only for Yuno-owned providers (a catalogue id containing YUNO, e.g. YUNO_3DS); any other provider is rejected with 400.

Maximum string length: 255

Example:

"Acme Risk"

Response

The stored override.

provider_id

string

Yuno catalogue provider id, UPPER_SNAKE_CASE.

Example:

"STRIPE"

instructions

object[]

Connection steps replacing the catalogue's.

setup_instructions

object[]

Grouped setup steps replacing the catalogue's.

more_info_url

string<uri>

Documentation link replacing the catalogue's, when overridden. Always https.

Example:

"https://docs.example.com/stripe"

name

string

Display name replacing the catalogue's, when overridden. Only Yuno-owned providers can carry one.

Example:

"Acme Risk"

created_at

string<date-time>

read-only

When the override was first written.

Example:

"2026-09-02T13:54:13Z"

updated_at

string<date-time>

read-only

When the override was last written.

Example:

"2026-09-02T13:54:13Z"

created_by

string<uuid>

read-only

The dashboard user who created it. Overrides written through this API carry the all-zero sentinel 00000000-0000-0000-0000-000000000000, meaning "written through the API" rather than by a person in the dashboard.

Example:

"00000000-0000-0000-0000-000000000000"

updated_by

string<uuid>

read-only

The dashboard user who last updated it, with the same sentinel rule as created_by.

Example:

"00000000-0000-0000-0000-000000000000"

⌘I

Replace a Provider's Instruction Override

curl --request PUT \
  --url https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "name": "Acme Risk"
}
'

import requests

url = "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions"

payload = {
    "instructions": [{}],
    "setup_instructions": [{}],
    "more_info_url": "https://docs.example.com/stripe",
    "name": "Acme Risk"
}
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    instructions: [{}],
    setup_instructions: [{}],
    more_info_url: 'https://docs.example.com/stripe',
    name: 'Acme Risk'
  })
};

fetch('https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'instructions' => [
        [
                
        ]
    ],
    'setup_instructions' => [
        [
                
        ]
    ],
    'more_info_url' => 'https://docs.example.com/stripe',
    'name' => 'Acme Risk'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "PRIVATE-SECRET-KEY: <api-key>",
    "PUBLIC-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions"

	payload := strings.NewReader("{\n  \"instructions\": [\n    {}\n  ],\n  \"setup_instructions\": [\n    {}\n  ],\n  \"more_info_url\": \"https://docs.example.com/stripe\",\n  \"name\": \"Acme Risk\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": [\n    {}\n  ],\n  \"setup_instructions\": [\n    {}\n  ],\n  \"more_info_url\": \"https://docs.example.com/stripe\",\n  \"name\": \"Acme Risk\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/whitelabel/providers/{provider_id}/instructions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": [\n    {}\n  ],\n  \"setup_instructions\": [\n    {}\n  ],\n  \"more_info_url\": \"https://docs.example.com/stripe\",\n  \"name\": \"Acme Risk\"\n}"

response = http.request(request)
puts response.read_body

{
  "provider_id": "STRIPE",
  "instructions": [
    {}
  ],
  "setup_instructions": [
    {}
  ],
  "more_info_url": "https://docs.example.com/stripe",
  "name": "Acme Risk",
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}

{
  "type": "about:blank",
  "title": "Invalid provider instructions",
  "status": 400,
  "detail": "The instruction override was rejected",
  "violations": [
    "name: only Yuno's own providers can be renamed; 'STRIPE' cannot"
  ]
}

{
  "code": "NOT_AUTHENTICATED",
  "messages": [
    "Not authenticated"
  ]
}

{
  "code": "VALIDATION_ERROR",
  "messages": [
    "Request body is too large"
  ]
}