Skip to main content
GET
/
api
/
v1
/
kyc
/
integration
Retrieve Link for Web Integration
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gnosispay.com/api/v1/kyc/integration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "type": "SUMSUB_WEB",
  "url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gnosispay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
lang
string

Optional language code in ISO 639-1 format (2 letters) to force the KYC flow language. If not provided, SumSub will use its own rules to determine the language.

Pattern: ^[a-z]{2}$
Example:

"en"

Response

The KYC integration specification.

​
type
enum<string>
required

The type of the KYC integration.

Available options:
SUMSUB_WEB
​
url
string<url>
required

The url that needs to be opened to follow through the SumSub KYC flow.