Generate KYC Applicant Share Token

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({forClientId: '<string>', ttlInSecs: 2})
};

fetch('https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "forClientId": "<string>",
  "ttlInSecs": 2
}
'

import requests

url = "https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant"

payload = {
    "forClientId": "<string>",
    "ttlInSecs": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant"

	payload := strings.NewReader("{\n  \"forClientId\": \"<string>\",\n  \"ttlInSecs\": 2\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://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"forClientId\": \"<string>\",\n  \"ttlInSecs\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant")

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  \"forClientId\": \"<string>\",\n  \"ttlInSecs\": 2\n}"

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

{
  "token": "<string>",
  "forClientId": "<string>"
}

{
  "kind": "validation",
  "success": false,
  "error": {
    "name": "ValidationError",
    "message": "<string>"
  }
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

POST

kyc

import-partner-applicant

Generate KYC Applicant Share Token

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({forClientId: '<string>', ttlInSecs: 2})
};

fetch('https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request POST \
  --url https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "forClientId": "<string>",
  "ttlInSecs": 2
}
'

import requests

url = "https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant"

payload = {
    "forClientId": "<string>",
    "ttlInSecs": 2
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant"

	payload := strings.NewReader("{\n  \"forClientId\": \"<string>\",\n  \"ttlInSecs\": 2\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://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"forClientId\": \"<string>\",\n  \"ttlInSecs\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://core.prod.gnosispay.com/user-api/kyc/import-partner-applicant")

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  \"forClientId\": \"<string>\",\n  \"ttlInSecs\": 2\n}"

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

{
  "token": "<string>",
  "forClientId": "<string>"
}

{
  "kind": "validation",
  "success": false,
  "error": {
    "name": "ValidationError",
    "message": "<string>"
  }
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

{
  "success": false,
  "error": "<string>"
}

Body

application/json

forClientId

string

required

Sumsub client ID of the recipient configured to receive applicant data.

Minimum string length: 1

ttlInSecs

integer<int32>

Share-token lifespan in seconds. When omitted, Sumsub's default of 1200 seconds applies.

Required range: x >= 1

Response

The request has succeeded.

token

string

required

Opaque, single-use Sumsub share token.

forClientId

string

required

Recipient client ID confirmed by Sumsub.

Auth

User

Terms

Source of Funds

Phone

User Account

Cards

User Movements

KYC

PCI

Health

Generate KYC Applicant Share Token

Body

Response