Soft check whether a KYC certificate could be issued (non-billable dry run)

POST

products

kyc_certificate_snapshot

query

soft

Soft check whether a KYC certificate could be issued (non-billable dry run)

curl --request POST \
  --url https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "furnishing_entity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "consent_id": "<string>",
  "consumer_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft"

payload = {
    "network_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "furnishing_entity_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "consent_id": "<string>",
    "consumer_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    network_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    policy_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    furnishing_entity_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    consent_id: '<string>',
    consumer_identity_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft', 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.solo.one/v1/products/kyc_certificate_snapshot/query/soft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'network_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'policy_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'furnishing_entity_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'consent_id' => '<string>',
    'consumer_identity_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.solo.one/v1/products/kyc_certificate_snapshot/query/soft"

	payload := strings.NewReader("{\n  \"network_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"furnishing_entity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"consent_id\": \"<string>\",\n  \"consumer_identity_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"network_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"furnishing_entity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"consent_id\": \"<string>\",\n  \"consumer_identity_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"network_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"furnishing_entity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"consent_id\": \"<string>\",\n  \"consumer_identity_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "issuable": true,
  "missing_data_paths": [
    "<string>"
  ],
  "matched_models": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

network_ids

string<uuid>[]

required

Networks to query across; the single policy is applied to all of them.

Minimum array length: 1

policy_id

string<uuid> | null

Querying policy applied across every network in network_ids. If omitted, each network's default policy is used.

furnishing_entity_ids

string<uuid>[] | null

Optional furnishing-entity scope. When omitted or empty, data from all furnishers is considered.

Consent token — system resolves identity + applies field access filtering.

consumer_identity_id

string<uuid> | null

Consumer profile primary key (ConsumerIdentity.id) for permissible-purpose (FCRA) queries.

Response

Successful Response

Result of a non-billable certificate soft check (dry run).

Carries whether a complete certificate could be issued for the exact query selections (subject, policy, networks, furnishers), which product models have a populated sub-product in the resolved result, and which policy-required data paths are missing. No resolved field values are returned — the soft check reveals issuability and match shape, never the underlying data. Soft checks always return an HTTP 200 body so clients can read matched_models / missing_data_paths when issuable is false.

issuable

boolean

required

Whether the same query would produce a complete certificate.

missing_data_paths

string[]

Policy-required certificate data paths absent for the selections (empty when issuable).

matched_models

string[]

Product model names with a populated certificate sub-product for these selections (no field values).

⌘I

Soft check whether a KYC certificate could be issued (non-billable dry run)

curl --request POST \
  --url https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "furnishing_entity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "consent_id": "<string>",
  "consumer_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft"

payload = {
    "network_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "furnishing_entity_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "consent_id": "<string>",
    "consumer_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    network_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    policy_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    furnishing_entity_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    consent_id: '<string>',
    consumer_identity_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft', 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.solo.one/v1/products/kyc_certificate_snapshot/query/soft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'network_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'policy_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'furnishing_entity_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'consent_id' => '<string>',
    'consumer_identity_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.solo.one/v1/products/kyc_certificate_snapshot/query/soft"

	payload := strings.NewReader("{\n  \"network_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"furnishing_entity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"consent_id\": \"<string>\",\n  \"consumer_identity_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.post("https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"network_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"furnishing_entity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"consent_id\": \"<string>\",\n  \"consumer_identity_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.solo.one/v1/products/kyc_certificate_snapshot/query/soft")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"network_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"policy_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"furnishing_entity_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"consent_id\": \"<string>\",\n  \"consumer_identity_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "issuable": true,
  "missing_data_paths": [
    "<string>"
  ],
  "matched_models": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Overview

Other

Soft check whether a KYC certificate could be issued (non-billable dry run)

Authorizations

Body

Response