SumSub App Token Examples

https://github.com/sumsubstance/apptokenusageexamples
Admin
SumSub App Token Examples provides multi-language code samples for authenticating and integrating...
Tokens:30,007
Snippets:385
Trust Score:7.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run the PHP example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Commands to install dependencies and execute the provided example script.

```bash
cd Php
composer install
php example.php
```

--------------------------------

### Check Go Installation

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/GoLang/README.md

Verify that Go is installed on your system by checking its version. Ensure Go is installed before proceeding with package installation and running examples.

```shell
go version
```

--------------------------------

### Client Initialization Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Example of instantiating the SumsubClient with sandbox credentials.

```php
$client = new SumsubClient(
    'sbx:uY0CgwELmgUAEyl4hNWxLngb.0WSeQeiYny4WEqmAALEAiK2qTC96fBad',
    'Hej2ch71kG2kTd1iIUDZFNsO5C1lh5Gq'
);
```

--------------------------------

### Example output

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Expected console output after running the integration example.

```text
The applicant was successfully created: 5f87c2fa7c72c80024e88e65
Identifier of the added document: 5f87d2ff7c72c80024e88e7a
Applicant status (json): {"idDocTypes":[{"idDocType":"PASSPORT","status":"SUBMITTED"}]}
Access token (json): {"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}
```

--------------------------------

### Add Document Usage Examples

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Client-side implementation examples for JavaScript and PHP.

```javascript
const response = await axios(addDocument("5f87c2fa7c72c80024e88e65"));
console.log(response.data.imageId);
```

```php
$imageId = $client->addDocument(
    '5f87c2fa7c72c80024e88e65',
    '/path/to/passport.jpg',
    ['idDocType' => 'PASSPORT', 'country' => 'GBR']
);
```

--------------------------------

### Access Token Usage Examples

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Language-specific examples for retrieving the token from the response.

```javascript
const response = await axios(createAccessToken("user-123", "basic-kyc-level", 1200));
const sdkToken = response.data.token;
```

```java
String tokenJson = getAccessToken("user-123", "basic-kyc-level");
Map tokenData = objectMapper.readValue(tokenJson, Map.class);
String sdkToken = (String) tokenData.get("token");
```

--------------------------------

### Example Usage for Applicant Data

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Client-side implementation examples for retrieving applicant data.

```go
applicant := GetApplicantInfo(applicant)
fmt.Println(applicant.Review.ReviewStatus)
```

```ruby
response_str = get_applicant_data("5f87c2fa7c72c80024e88e65")
applicant = JSON.parse(response_str)
```

--------------------------------

### Run JavaScript App Token Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/JS/README.md

Execute the main JavaScript example file using Node.js.

```shell
node AppTokenJsExample.js
```

--------------------------------

### Execute GET Request Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates how to invoke the SendGet method for a specific API resource path.

```csharp
var response = await SendGet("/resources/applicants/5f87c2fa7c72c80024e88e65/requiredIdDocsStatus");
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/JS/README.md

Install all necessary project dependencies using npm.

```shell
npm i
```

--------------------------------

### Generate SDK access token example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Usage example for generating and printing an SDK access token.

```python
sdk_token = get_access_token('user-123', 'basic-kyc-level')
print(f"SDK Token: {sdk_token}")
```

--------------------------------

### Create Applicant Usage Examples

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Implementation examples for creating an applicant across different programming languages.

```javascript
const response = await axios(createApplicant("user-123", "basic-kyc-level"));
const applicantId = response.data.id;
```

```python
applicant_id = create_applicant("user-123", "basic-kyc-level")
```

```go
applicant := CreateApplicant(applicant, "basic-kyc-level")
fmt.Println(applicant.ID)
```

--------------------------------

### Check Node and NPM Installation

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/JS/README.md

Verify that Node.js and npm are installed on your system before proceeding.

```shell
node --version
npm --version
```

--------------------------------

### Usage example for signed_header

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example call to generate headers for a GET request.

```ruby
headers = signed_header("applicants/123/requiredIdDocsStatus", nil, "GET")
# Returns:
# {
#   "X-App-Token": "sbx:...",
#   "X-App-Access-Sig": "a1b2c3d4...",
#   "X-App-Access-Ts": "1625097600",
#   "Accept": "application/json",
#   "Content-Type": "application/json"
# }
```

--------------------------------

### Install Go Packages

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/GoLang/README.md

Download and install any missing Go packages required for the project. This command ensures all dependencies are met.

```shell
go mod tidy
```

--------------------------------

### GenerateAccessToken Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Demonstrates how to call the function and print the resulting token.

```go
token := GenerateAccessToken(applicant)
fmt.Println("SDK Token:", token.Token)
```

--------------------------------

### Run C# Example via CLI

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Commands to navigate to the project directory, restore dependencies, and execute the application.

```bash
cd "C#/AppTokenCSharpExample"
dotnet restore
dotnet run
```

--------------------------------

### Create Applicant Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Demonstrates how to invoke the createApplicant method with required parameters.

```php
$applicantId = $client->createApplicant('user-123', 'basic-kyc-level');
echo "Applicant created: $applicantId";
```

--------------------------------

### Execute POST Request Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates how to prepare an HttpRequestMessage and invoke the SendPost method.

```csharp
var requestBody = new HttpRequestMessage(HttpMethod.Post, "https://api.sumsub.com")
{
    Content = new StringContent(json, Encoding.UTF8, "application/json")
};
var response = await SendPost("/resources/applicants?levelName=basic-kyc-level", requestBody);
```

--------------------------------

### Request Signing Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

A concrete example showing the construction of the message string and the resulting HMAC-SHA256 signature calculation.

```text
timestamp = "1607085670"
method = "POST"
path = "/resources/applicants?levelName=basic-kyc-level"
body = '{"externalUserId":"user-123"}'

message = "1607085670POST/resources/applicants?levelName=basic-kyc-level{\"externalUserId\":\"user-123\"}"
secret = "Hej2ch71kG2kTd1iIUDZFNsO5C1lh5Gq"

signature = HMAC-SHA256(secret, message)  // Returns hex string
```

--------------------------------

### Get Applicant Status Implementation

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Language-specific examples for calling the applicant status endpoint.

```python
response = get_applicant_status("5f87c2fa7c72c80024e88e65")
status = response.json()
print(status['idDocTypes'])
```

```csharp
var response = await GetApplicantStatus("5f87c2fa7c72c80024e88e65");
var status = JsonConvert.DeserializeObject(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Minimal integration example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Demonstrates initializing the SumsubClient and performing core operations like creating an applicant, uploading documents, and retrieving status.

```php
<?php
require 'vendor/autoload.php';

use Sumsub\AppTokenUsageExample\SumsubClient;

$client = new SumsubClient(
    'YOUR_APP_TOKEN',
    'YOUR_SECRET_KEY'
);

// Create applicant
$applicantId = $client->createApplicant('user-' . uniqid(), 'basic-kyc-level');
echo "Created applicant: $applicantId\n";

// Upload document
$imageId = $client->addDocument(
    $applicantId,
    '/path/to/document.jpg',
    ['idDocType' => 'PASSPORT', 'country' => 'GBR']
);
echo "Uploaded document: $imageId\n";

// Get status
$status = $client->getApplicantStatus($applicantId);
echo "Status: " . json_encode($status) . "\n";

// Get SDK token
$token = $client->getAccessToken('user-123', 'basic-kyc-level');
echo "SDK Token: " . $token['token'] . "\n";
```

--------------------------------

### Run GoLang HMAC-SHA256 Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/GoLang/README.md

Execute the GoLang application token example that utilizes HMAC-SHA256. This command compiles and runs the specified Go file.

```shell
go run GoLangAppTokensHmacSha256.go
```

--------------------------------

### Run Java Project via Maven

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

Commands to build and execute the Java example application from the command line.

```bash
cd Java
mvn clean install
mvn exec:java -Dexec.mainClass="AppTokenJavaExample"
```

--------------------------------

### GetApplicantInfo Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Demonstrates how to retrieve applicant information and access specific fields like review status and document count.

```go
updated := GetApplicantInfo(applicant)
fmt.Println("Applicant status:", updated.Review.ReviewStatus)
fmt.Println("Documents submitted:", len(updated.Info.IdDocs))
```

--------------------------------

### Retrieve applicant status example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Usage example for fetching and printing the applicant status JSON.

```python
response = get_applicant_status('5f87c2fa7c72c80024e88e65')
status = response.json()
print(json.dumps(status, indent=2))
```

--------------------------------

### Generate access token example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example usage of generate_access_token to retrieve a token and display its expiration time.

```ruby
token_data = generate_access_token("user-123", "basic-kyc-level", 1200)
sdk_token = token_data['token']
puts "Token expires in: #{token_data['ttlInSecs']} seconds"
```

--------------------------------

### Sign and Send API Request

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Example usage of the sign_request function to authenticate and execute a GET request.

```python
req = requests.Request('GET', 'https://api.sumsub.com/resources/applicants/123/status')
signed = sign_request(req)
response = requests.Session().send(signed, timeout=60)
```

--------------------------------

### Add Document Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Demonstrates how to upload a document for a specific applicant ID.

```python
image_id = add_document('5f87c2fa7c72c80024e88e65')
print(f"Document uploaded: {image_id}")
```

--------------------------------

### Usage Example for createApplicant

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

Demonstrates how to invoke the createApplicant method and print the resulting applicant ID.

```java
String applicantId = createApplicant("user-123", "basic-kyc-level");
System.out.println("Created: " + applicantId);
```

--------------------------------

### Upload Photo Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example usage of the upload_photo method and parsing the resulting JSON response.

```ruby
response_str = upload_photo("5f87c2fa7c72c80024e88e65")
response_json = JSON.parse(response_str)
```

--------------------------------

### Usage example for signed_message

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example call to generate a signature for a POST request.

```ruby
sig = signed_message(1625097600, "applicants?levelName=basic-kyc-level", '{"externalUserId":"user"}', "POST")
# Returns: "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6..."
```

--------------------------------

### Retrieve applicant data example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example usage of get_applicant_data to fetch and parse the full applicant profile.

```ruby
response_str = get_applicant_data("5f87c2fa7c72c80024e88e65")
applicant = JSON.parse(response_str)
```

--------------------------------

### ContentToString Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates reading response content and printing it to the console.

```csharp
var text = ContentToString(response.Content);
Console.WriteLine($"Response: {text}");
```

--------------------------------

### Install PHP Dependencies

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Required Guzzle and PSR-7 packages for the PHP client.

```json
{
  "require": {
    "guzzlehttp/guzzle": "^7.0",
    "guzzlehttp/psr7": "^2.0"
  }
}
```

```bash
composer require guzzlehttp/guzzle guzzlehttp/psr7
```

--------------------------------

### Add Document Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Demonstrates how to upload a document using an applicant ID, file path, and metadata array.

```php
$imageId = $client->addDocument(
    '5f87c2fa7c72c80024e88e65',
    '/path/to/passport.jpg',
    ['idDocType' => 'PASSPORT', 'country' => 'GBR']
);
echo "Document uploaded, image ID: $imageId";
```

--------------------------------

### AddDocument Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates how to upload a document for a specific applicant and read the response.

```csharp
var response = await AddDocument("5f87c2fa7c72c80024e88e65");
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine($"Response: {content}");
```

--------------------------------

### Run Sumsub Go Application

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Commands to install dependencies and execute the Go application with required environment variables.

```bash
cd GoLang
go get github.com/google/uuid
go get github.com/k0kubun/pp
go get github.com/pkg/errors
SUMSUB_APP_TOKEN=sbx:xxxxx SUMSUB_SECRET_KEY=yyyyy go run GoLangAppTokensHmacSha256.go
```

--------------------------------

### CreateApplicant Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates how to invoke the CreateApplicant method and access the resulting applicant ID.

```csharp
var applicant = await CreateApplicant("user-123", "basic-kyc-level");
Console.WriteLine($"Applicant ID: {applicant.id}");
```

--------------------------------

### Run the KYC script

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/javascript.md

Commands to install dependencies and execute the script with required environment variables.

```bash
cd JS
npm install
SUMSUB_APP_TOKEN=sbx:xxxxx SUMSUB_SECRET_KEY=yyyyy node AppTokenJsExample.js
```

--------------------------------

### Example Metadata JSON

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/types.md

Sample JSON objects for document upload metadata.

```json
{
  "idDocType": "PASSPORT",
  "country": "GBR"
}
```

```json
{
  "idDocType": "ID_CARD",
  "country": "DEU",
  "idDocSubType": "FRONT_SIDE"
}
```

--------------------------------

### Create Applicant Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Demonstrates how to invoke the create_applicant function with a user ID and verification level.

```python
applicant_id = create_applicant('user-123', 'basic-kyc-level')
print(f"Created applicant: {applicant_id}")
```

--------------------------------

### Retrieve applicant status example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example usage of get_applicant_status to fetch and parse the verification status response.

```ruby
response_str = get_applicant_status("5f87c2fa7c72c80024e88e65")
status = JSON.parse(response_str)
puts status.inspect
```

--------------------------------

### Create Applicant Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/javascript.md

Demonstrates how to invoke the createApplicant function and handle the resulting Axios response.

```javascript
const response = await axios(createApplicant("user-123", "basic-kyc-level"));
const applicantId = response.data.id;
console.log("Created applicant:", applicantId);
```

--------------------------------

### Minimal Java API Request Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

Demonstrates how to sign a request using HmacSHA256 and send it with the required authentication headers using OkHttp.

```java
import com.squareup.okhttp3.*;
import org.apache.commons.codec.binary.Hex;

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.nio.charset.StandardCharsets;
import java.time.Instant;

public class Example {
    static final String TOKEN = "sbx:token";
    static final String SECRET = "secret";
    static final String BASE_URL = "https://api.sumsub.com";

    public static void main(String[] args) throws Exception {
        // Create applicant
        String body = "{\"externalUserId\":\"user-123\"}";
        long ts = Instant.now().getEpochSecond();
        
        // Sign
        Mac hmac = Mac.getInstance("HmacSHA256");
        hmac.init(new SecretKeySpec(SECRET.getBytes(StandardCharsets.UTF_8), "HmacSHA256"));
        String sig = Hex.encodeHexString(hmac.doFinal((ts + "POST/resources/applicants?levelName=basic-kyc-level" + body).getBytes()));
        
        // Request
        RequestBody reqBody = RequestBody.create(body, MediaType.parse("application/json"));
        Request request = new Request.Builder()
            .url(BASE_URL + "/resources/applicants?levelName=basic-kyc-level")
            .header("X-App-Token", TOKEN)
            .header("X-App-Access-Ts", String.valueOf(ts))
            .header("X-App-Access-Sig", sig)
            .post(reqBody)
            .build();
        
        OkHttpClient client = new OkHttpClient();
        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}
```

--------------------------------

### Run script via CLI

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Commands to install dependencies and execute the script with environment variables.

```bash
cd Python
pip install requests
SUMSUB_APP_TOKEN=sbx:xxxxx SUMSUB_SECRET_KEY=yyyyy python AppTokenPythonExample.py
```

--------------------------------

### AddDocument Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Demonstrates how to call AddDocument with an applicant ID and print the resulting document metadata.

```go
doc := AddDocument("5f87c2fa7c72c80024e88e65")
fmt.Println("Uploaded document:", doc.IdDocType, "for", doc.Country)
```

--------------------------------

### CreateSignature Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates how to invoke the signature generation method with a timestamp, HTTP method, path, and body bytes.

```csharp
var sig = CreateSignature(1625097600, HttpMethod.Post, "/resources/applicants", bodyBytes);
// Returns: "a1b2c3d4e5f6g7h8..."
```

--------------------------------

### Serialize Metadata

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Example of serializing document metadata into the required JSON format.

```ruby
Metadata.new(IdDocType::PASSPORT, 'GBR').serialize
# Results in: {"idDocType":"PASSPORT","country":"GBR"}
```

--------------------------------

### Add Document Usage Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/javascript.md

Demonstrates how to invoke the addDocument function using an applicant ID.

```javascript
const response = await axios(addDocument("5f87c2fa7c72c80024e88e65"));
console.log("Document uploaded:", response.data.imageId);
```

--------------------------------

### Minimal Ruby API Request Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Shows how to generate signed headers and perform a POST request to the Sumsub API using RestClient.

```ruby
require 'rest-client'
require 'json'
require 'openssl'

APP_TOKEN = 'sbx:token'
SECRET_KEY = 'secret'

def signed_header(resource, body = nil)
  ts = Time.now.to_i
  data = "#{ts}POST/resources/#{resource}#{body}"
  digest = OpenSSL::Digest.new('sha256')
  sig = OpenSSL::HMAC.hexdigest(digest, SECRET_KEY, data)
  
  {
    'X-App-Token': APP_TOKEN,
    'X-App-Access-Sig': sig,
    'X-App-Access-Ts': ts.to_s,
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  }
end

# Create applicant
url = 'https://api.sumsub.com/resources/applicants?levelName=basic-kyc-level'
body = '{"externalUserId":"user-123"}'
headers = signed_header('applicants?levelName=basic-kyc-level', body)

response = RestClient.post(url, body, headers)
puts JSON.parse(response)
```

--------------------------------

### Applicant Deserialization Example

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Shows how to deserialize a JSON string into an Applicant object using Newtonsoft.Json.

```csharp
var json = @"{""id"":""5f87c2fa7c72c80024e88e65""", ""externalUserId"":""user-123""}";
var applicant = JsonConvert.DeserializeObject<Applicant>(json);
```

--------------------------------

### Example IdDoc JSON

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/types.md

A sample JSON object representing an identity document.

```json
{
  "idDocType": "PASSPORT",
  "country": "GBR",
  "firstName": "John",
  "lastName": "Smith",
  "dob": "1990-05-15"
}
```

--------------------------------

### Example JSON payload for Info

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/types.md

A sample JSON object representing user personal information.

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "dob": "1990-05-15",
  "gender": "M",
  "country": "GBR",
  "phone": "+442071838750"
}
```

--------------------------------

### Create Applicant Response JSON

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Example JSON response structure returned after successfully creating an applicant.

```json
{
  "id": "5f87c2fa7c72c80024e88e65",
  "externalUserId": "user-123",
  "review": { "reviewStatus": "onApproval" }
}
```

--------------------------------

### Minimal Sumsub API Request

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

A complete example demonstrating how to sign a POST request using HMAC-SHA256 and execute it against the Sumsub API.

```go
package main

import (
    "bytes"
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
    "encoding/json"
    "fmt"
    "net/http"
    "time"
)

func main() {
    // Create applicant
    body := []byte(`{"externalUserId":"user-123"}`)
    
    // Sign request
    ts := fmt.Sprintf("%d", time.Now().Unix())
    sig := hmac.New(sha256.New, []byte("secret"))
    sig.Write([]byte(ts + "POST" + "/resources/applicants?levelName=basic-kyc-level"))
    sig.Write(body)
    
    // Execute request
    req, _ := http.NewRequest("POST", "https://api.sumsub.com/resources/applicants?levelName=basic-kyc-level", bytes.NewBuffer(body))
    req.Header.Add("X-App-Token", "sbx:token")
    req.Header.Add("X-App-Access-Ts", ts)
    req.Header.Add("X-App-Access-Sig", hex.EncodeToString(sig.Sum(nil)))
    
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    
    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)
    fmt.Println("Applicant ID:", result["id"])
}
```

--------------------------------

### Access token response format

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Example JSON structure returned by the access token endpoint.

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "userId": "user-123",
  "ttlInSecs": 600
}
```

--------------------------------

### Generate SDK Access Token in C#

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Defines the method signature for token generation and provides an example of retrieving and parsing the token from the response.

```csharp
public static async Task<HttpResponseMessage> GetAccessToken(string externalUserId, string levelName)
```

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "userId": "user-123",
  "ttlInSecs": 600
}
```

```csharp
var response = await GetAccessToken("user-123", "basic-kyc-level");
var content = await response.Content.ReadAsStringAsync();
dynamic tokenData = JsonConvert.DeserializeObject(content);
Console.WriteLine($"Token: {tokenData.token}");
```

--------------------------------

### Run Ruby Script via CLI

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Command to install dependencies and execute the script with required environment variables.

```bash
cd Ruby/appTokenRuby
bundle install
SUMSUB_APP_TOKEN=sbx:xxxxx SUMSUB_SECRET_KEY=yyyyy ruby main.rb
```

--------------------------------

### Create New Applicant

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Defines the applicant creation function signature and provides a usage example for initializing and submitting an applicant.

```go
func CreateApplicant(applicant model.Applicant, levelName string) model.Applicant
```

```go
applicant := model.Applicant{
    ExternalUserID: "user-123",
    FixedInfo: model.Info{
        Country: "GBR",
        FirstName: "John",
    },
}
created := CreateApplicant(applicant, "basic-kyc-level")
fmt.Println("Created applicant ID:", created.ID)
```

--------------------------------

### Document Upload Response JSON Structure

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/javascript.md

Example JSON response returned after successfully uploading a document.

```json
{
  "imageId": "5f87d2ff7c72c80024e88e7a",
  "docType": "PASSPORT"
}
```

--------------------------------

### Execute Authenticated API Request

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Example usage of _makeSumsubRequest to perform a POST request to the applicants resource.

```go
body := []byte(`{"externalUserId":"user-123"}`)
response, err := _makeSumsubRequest("/resources/applicants?levelName=basic-kyc-level", "POST", "application/json", body)
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(response))
```

--------------------------------

### SendGet Method Signature

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Defines the signature for the protected method used to execute signed GET requests.

```csharp
private static async Task<HttpResponseMessage> SendGet(string url)
```

--------------------------------

### Define SumSub Configuration Constants

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Set the API base URL and authentication credentials. Sandbox tokens must be prefixed with 'sbx:'.

```go
const URL = "https://api.sumsub.com"
const SumsubAppToken = "sbx:6L6rqHEtRVvBKKt7P1A03k2x.h6OsEOXWpyaXAjvBVNnx3ccXNGTBLHkw"
const SumsubSecretKey = "EraepapR4Grr2vI1eZWtTkFDhbhsC5EI"
```

--------------------------------

### Execute Authenticated GET Request

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

Executes a signed GET request to the specified API path using the internal sendGet method.

```java
Response response = sendGet("/resources/applicants/123/requiredIdDocsStatus");
```

--------------------------------

### Initialize SumSub Web SDK

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Client-side implementation to initialize the SDK using the generated access token.

```javascript
// Client-side code
import SumsubWebSdk from '@sumsub/websdk-core';

const accessToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';

SumsubWebSdk.init()
  .withAccessToken(accessToken)
  .withConf({
    lang: 'en'
  })
  .build()
  .launch('#sumsub-container');
```

--------------------------------

### GET /resources/applicants/{applicantId}/requiredIdDocsStatus

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Retrieves the verification status for an applicant.

```APIDOC
## GET /resources/applicants/{applicantId}/requiredIdDocsStatus

### Description
Retrieves the verification status for an applicant.

### Method
GET

### Endpoint
/resources/applicants/{applicantId}/requiredIdDocsStatus

### Parameters
#### Path Parameters
- **applicantId** (string) - Required - ID from CreateApplicant()

### Response
#### Success Response (200)
- **Response** (JSON) - JSON with document type requirements
```

--------------------------------

### Execute KYC Workflow in Ruby

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Demonstrates the sequence of creating an applicant, generating an access token, uploading documents, and retrieving status.

```ruby
uuid = SecureRandom.uuid
level_name = 'basic-kyc-level'
lang = 'en'

# 1. Create applicant
response = JSON.parse(create_applicant(uuid, lang, level_name))
puts("applicant_id #{response['id']}")
applicant_id = response['id']

# 2. Generate access token
puts(generate_access_token(uuid, level_name))

# 3. Upload document
puts(upload_photo(applicant_id))

# 4. Get applicant data
puts(get_applicant_data(applicant_id))

# 5. Get applicant status
puts(get_applicant_status(applicant_id))
```

--------------------------------

### Applicant JSON representation

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/types.md

Example of a serialized Applicant object returned by the API.

```json
{
  "id": "5f87c2fa7c72c80024e88e65",
  "externalUserId": "user-123",
  "createdAt": "2020-10-16T12:34:56.000Z",
  "lang": "en",
  "review": {
    "reviewStatus": "completed",
    "reviewAnswer": "GREEN"
  }
}
```

--------------------------------

### Constructor Definition

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Initializes the client with the required application token and secret key.

```php
public function __construct(
    protected string $appToken,
    protected string $secretKey
)
```

--------------------------------

### GET /resources/applicants/{id}/one

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/INDEX.md

Retrieves complete data for a specific applicant.

```APIDOC
## GET /resources/applicants/{id}/one

### Description
Fetches the full applicant profile data.

### Method
GET

### Endpoint
/resources/applicants/{id}/one
```

--------------------------------

### SumsubClient::__construct

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/php.md

Initializes the Sumsub client with the required application token and secret key for authentication.

```APIDOC
## SumsubClient::__construct

### Description
Initializes the Sumsub client with credentials. This constructor sets up the internal Guzzle HTTP client configured with the base URL for the Sumsub API.

### Signature
`public function __construct(string $appToken, string $secretKey)`

### Parameters
- **$appToken** (string) - Required - Application token from SumSub dashboard (prefix `sbx:` for sandbox).
- **$secretKey** (string) - Required - Secret key for HMAC-SHA256 signing.

### Usage Example
```php
$client = new SumsubClient(
    'sbx:uY0CgwELmgUAEyl4hNWxLngb.0WSeQeiYny4WEqmAALEAiK2qTC96fBad',
    'Hej2ch71kG2kTd1iIUDZFNsO5C1lh5Gq'
);
```
```

--------------------------------

### Access Token Response Body

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Example JSON response containing the JWT token.

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Zjg3YzJmYTdjNzJjODAwMjRlODhlNjUiLCJpYXQiOjE2MDcwODU2NzAsImV4cCI6MTYwNzA4NzAzMH0.a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4",
  "userId": "user-123",
  "ttlInSecs": 1200
}
```

--------------------------------

### Define Main Entry Point

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

The main method serves as the entry point for the KYC workflow, requiring handling for IO and cryptographic exceptions.

```java
public static void main(String[] args) throws IOException, InvalidKeyException, NoSuchAlgorithmException
```

--------------------------------

### Define Configuration Constants

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Set these constants with your specific credentials from the SumSub dashboard. Sandbox tokens must be prefixed with 'sbx:'.

```csharp
private static readonly string SUMSUB_SECRET_KEY = "SUMSUB_SECRET_KEY";
private static readonly string SUMSUB_APP_TOKEN = "SUMSUB_APP_TOKEN";
private static readonly string SUMSUB_TEST_BASE_URL = "https://api.sumsub.com";
```

--------------------------------

### Define Main Entry Point

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

The entry point for the KYC workflow application.

```csharp
private static void Main(string[] args)
```

--------------------------------

### POST /resources/applicants

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/01-overview.md

Initialize a new applicant for the KYC process.

```APIDOC
## POST /resources/applicants

### Description
Initialize a new applicant for KYC.

### Method
POST

### Endpoint
/resources/applicants
```

--------------------------------

### Execute script entry point

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Standard Python entry point to execute the main function.

```python
if __name__ == '__main__':
    exit(main())
```

--------------------------------

### Applicant status response format

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Example JSON structure returned by the applicant status endpoint.

```json
{
  "idDocTypes": [
    {
      "idDocType": "PASSPORT",
      "status": "SUBMITTED"
    }
  ],
  "canBeSent": false
}
```

--------------------------------

### GET /resources/applicants/{id}/requiredIdDocsStatus

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/01-overview.md

Check the verification status of an applicant's identity documents.

```APIDOC
## GET /resources/applicants/{id}/requiredIdDocsStatus

### Description
Check verification status.

### Method
GET

### Endpoint
/resources/applicants/{id}/requiredIdDocsStatus

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the applicant.
```

--------------------------------

### CreateApplicant Method Definition

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Defines the method signature for creating a new applicant in the SumSub system.

```csharp
public static async Task<Applicant> CreateApplicant(string externalUserId, string levelName)
```

--------------------------------

### Project Directory Structure

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/README.md

The standard file layout for the SumSub API integration project.

```text
output/
├── README.md                          # This file
├── types.md                           # Data type definitions
├── endpoints.md                       # HTTP endpoint specifications
└── api-reference/
    ├── 01-overview.md                 # Project overview
    ├── javascript.md                  # JS/Node.js implementation
    ├── golang.md                      # Go implementation
    ├── php.md                         # PHP implementation
    ├── python.md                      # Python implementation
    ├── csharp.md                      # C# implementation
    ├── ruby.md                        # Ruby implementation
    └── java.md                        # Java implementation
```

--------------------------------

### GET /resources/applicants/{applicantId}/one

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Retrieves complete applicant information including extracted document data.

```APIDOC
## GET /resources/applicants/{applicantId}/one

### Description
Retrieves complete applicant information including extracted document data.

### Method
GET

### Endpoint
/resources/applicants/{applicantId}/one

### Parameters
#### Path Parameters
- **applicantId** (string) - Required - Applicant ID

### Response
#### Success Response (200)
- **id** (string) - Applicant ID
- **externalUserId** (string) - External User ID
- **createdAt** (string) - Creation timestamp
- **review** (object) - Review status details
- **info** (object) - Applicant personal information

#### Response Example
{
  "id": "5f87c2fa7c72c80024e88e65",
  "externalUserId": "user-123",
  "createdAt": "2020-10-16T12:34:56.000Z",
  "review": {
    "reviewStatus": "completed",
    "reviewAnswer": "GREEN",
    "startDate": "2020-10-16T12:35:00.000Z",
    "reviewDate": "2020-10-16T13:45:30.000Z"
  },
  "info": {
    "firstName": "John",
    "lastName": "Smith",
    "dob": "1990-05-15",
    "country": "GBR",
    "idDocs": [
      {
        "idDocType": "PASSPORT",
        "country": "GBR",
        "firstName": "JOHN",
        "lastName": "SMITH",
        "dob": "1990-05-15"
      }
    ]
  }
}
```

--------------------------------

### createApplicant(String externalUserId, String levelName)

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

Creates a new applicant in the SumSub system by sending a POST request with the provided user ID and verification level.

```APIDOC
## POST /resources/applicants?levelName={levelName}

### Description
Creates a new applicant in the SumSub system.

### Method
POST

### Endpoint
/resources/applicants?levelName={levelName}

### Parameters
#### Path Parameters
- **levelName** (String) - Required - Verification level (e.g., `basic-kyc-level`)

#### Request Body
- **externalUserId** (String) - Required - Unique identifier for user in your system

### Response
#### Success Response (200)
- **id** (String) - Applicant ID assigned by SumSub
- **externalUserId** (String) - Unique identifier for user in your system

### Response Example
{
  "id": "5f87c2fa7c72c80024e88e65",
  "externalUserId": "550e8400-e29b-41d4-a716-446655440000"
}
```

--------------------------------

### GET /resources/applicants/{applicantId}/requiredIdDocsStatus

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Retrieves the verification status and required document types for a specific applicant.

```APIDOC
## GET /resources/applicants/{applicantId}/requiredIdDocsStatus

### Description
Retrieves verification status and required documents for an applicant.

### Method
GET

### Endpoint
/resources/applicants/{applicantId}/requiredIdDocsStatus

### Parameters
#### Path Parameters
- **applicantId** (string) - Required - Applicant ID

### Request Headers
- **X-App-Token** (string) - Required - App token
- **X-App-Access-Ts** (string) - Required - Unix timestamp
- **X-App-Access-Sig** (string) - Required - HMAC signature
- **Accept** (string) - Required - application/json

### Response
#### Success Response (200)
- **idDocTypes** (array) - Required document types and their status
- **idDocTypes[].idDocType** (string) - Document type
- **idDocTypes[].status** (string) - PENDING, SUBMITTED, ACCEPTED, or REJECTED
- **canBeSent** (boolean) - Whether applicant can be sent for review

#### Response Example
{
  "idDocTypes": [
    {
      "idDocType": "PASSPORT",
      "status": "SUBMITTED"
    }
  ],
  "canBeSent": false
}

### Error Responses
- **404** (NOT_FOUND) - Applicant doesn't exist
- **401** (UNAUTHORIZED) - Invalid credentials
```

--------------------------------

### Create an Applicant across multiple languages

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/README.md

Demonstrates the function call to create an applicant with a user ID and KYC level in various programming languages.

```javascript
const applicantId = (await axios(createApplicant("user-123", "basic-kyc-level"))).data.id;
```

```go
applicant := CreateApplicant(model.Applicant{ExternalUserID: "user-123"}, "basic-kyc-level")
fmt.Println(applicant.ID)
```

```php
$applicantId = $client->createApplicant("user-123", "basic-kyc-level");
```

```python
applicant_id = create_applicant("user-123", "basic-kyc-level")
```

```csharp
var applicant = await CreateApplicant("user-123", "basic-kyc-level");
Console.WriteLine(applicant.id);
```

```ruby
response = JSON.parse(create_applicant("user-123", "en", "basic-kyc-level"))
applicant_id = response['id']
```

```java
String applicantId = createApplicant("user-123", "basic-kyc-level");
```

--------------------------------

### Minimal C# API Request Implementation

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/csharp.md

Demonstrates how to generate an HMAC-SHA256 signature and perform an authenticated POST request to the Sumsub API.

```csharp
using System;
using System.Net.Http;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        const string token = "sbx:xxxxx";
        const string secret = "yyyyy";
        const string baseUrl = "https://api.sumsub.com";
        
        // Create applicant
        var ts = DateTimeOffset.UtcNow.ToUnixTimeSeconds();
        var body = @"{""externalUserId"":""user-123""}";
        
        // Sign
        var hmac = new HMACSHA256(Encoding.ASCII.GetBytes(secret));
        var sig = hmac.ComputeHash(
            Encoding.ASCII.GetBytes(ts + "POST/resources/applicants?levelName=basic-kyc-level" + body)
        );
        var sigHex = BitConverter.ToString(sig).Replace("-", "").ToLower();
        
        // Request
        using (var client = new HttpClient())
        {
            var req = new HttpRequestMessage(HttpMethod.Post, 
                baseUrl + "/resources/applicants?levelName=basic-kyc-level")
            {
                Content = new StringContent(body, Encoding.UTF8, "application/json")
            };
            req.Headers.Add("X-App-Token", token);
            req.Headers.Add("X-App-Access-Ts", ts.ToString());
            req.Headers.Add("X-App-Access-Sig", sigHex);
            
            var resp = await client.SendAsync(req);
            Console.WriteLine(await resp.Content.ReadAsStringAsync());
        }
    }
}
```

--------------------------------

### CreateApplicant(applicant, levelName)

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Creates a new applicant in the SumSub system by marshaling the applicant struct and performing a POST request.

```APIDOC
## POST /resources/applicants?levelName={levelName}

### Description
Creates a new applicant in the SumSub system. This method handles the JSON marshaling of the applicant data and the subsequent API request.

### Parameters
- **applicant** (model.Applicant) - Required - Applicant struct
- **levelName** (string) - Required - Verification level (e.g., `basic-kyc-level`)

### Response
- **ID** (string) - Unique applicant ID assigned by SumSub
- **CreatedAt** (string) - Timestamp of creation
- **ExternalUserID** (string) - Echo of the provided external user ID
```

--------------------------------

### Generate HMAC-SHA256 Signature

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/golang.md

Defines the signature generation function signature and provides a usage example for request authentication.

```go
func _sign(ts string, secret string, method string, path string, body *[]byte) string
```

```go
sig := _sign("1625097600", "secretkey", "POST", "/resources/applicants", &bodyBytes)
// Returns: "a1b2c3d4e5f6..."
```

--------------------------------

### Configure SumSub API Constants

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Define the necessary credentials and base URL for API requests. Replace the placeholder strings with your actual SumSub dashboard values.

```python
SUMSUB_SECRET_KEY = "YOUR_SUMSUB_SECRET_KEY"  # Example: Hej2ch71kG2kTd1iIUDZFNsO5C1lh5Gq
SUMSUB_APP_TOKEN = "YOUR_SUMSUB_APP_TOKEN"    # Example: sbx:uY0CgwELmgUAEyl4hNWxLngb.0WSeQeiYny4WEqmAALEAiK2qTC96fBad
SUMSUB_TEST_BASE_URL = "https://api.sumsub.com"
REQUEST_TIMEOUT = 60  # Timeout in seconds
```

--------------------------------

### Implement API Error Handler

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/javascript.md

Example of catching errors in an axios request and handling specific status codes like 401.

```javascript
axios(createApplicant(userId, levelName))
  .catch(error => {
    const errorData = error.response?.data || error.message;
    console.error('Request failed:', errorData);
    if (error.response?.status === 401) {
      console.error('Invalid token or secret key');
    }
  });
```

--------------------------------

### POST /resources/accessTokens/sdk

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/endpoints.md

Creates a short-lived JWT token for initializing the SumSub Web SDK on the client side.

```APIDOC
## POST /resources/accessTokens/sdk

### Description
Creates a short-lived JWT token for initializing the SumSub Web SDK on the client side.

### Method
POST

### Endpoint
/resources/accessTokens/sdk

### Request Body
- **userId** (string) - Required - External user ID (same as applicant creation)
- **levelName** (string) - Required - Verification level
- **ttlInSecs** (integer) - Optional - Token lifetime in seconds (Default: 600)

### Request Example
{
  "userId": "user-123",
  "levelName": "basic-kyc-level",
  "ttlInSecs": 1200
}

### Response
#### Success Response (200)
- **token** (string) - JWT access token for SDK initialization
- **userId** (string) - Echo of input user ID
- **ttlInSecs** (integer) - Token validity period in seconds

#### Response Example
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "userId": "user-123",
  "ttlInSecs": 1200
}
```

--------------------------------

### Configure App Token and Secret Key

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/JS/README.md

Update the placeholder values for SUMSUB_APP_TOKEN and SUMSUB_SECRET_KEY with your actual credentials.

```javascript
const SUMSUB_APP_TOKEN = '';
const SUMSUB_SECRET_KEY = '';
```

--------------------------------

### Configure Maven Dependencies

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/java.md

Include these dependencies in your pom.xml to support OkHttp for networking and Jackson for JSON processing.

```xml
<dependencies>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.10.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>logging-interceptor</artifactId>
        <version>4.10.0</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.15.0</version>
    </dependency>
    <dependency>
        <groupId>commons-codec</groupId>
        <artifactId>commons-codec</artifactId>
        <version>1.15</version>
    </dependency>
</dependencies>
```

--------------------------------

### Configure SumSub Credentials

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/ruby.md

Define the application token and secret key constants using credentials from the SumSub dashboard.

```ruby
APP_TOKEN = 'YOUR_SUMSUB_APP_TOKEN'.freeze
SECRET_KEY = 'YOUR_SUMSUB_SECRET_KEY'.freeze
```

--------------------------------

### Configure API Credentials

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/javascript.md

Define the required authentication constants for the SumSub API. Replace the placeholder values with your actual sandbox or production credentials.

```javascript
const SUMSUB_APP_TOKEN = 'YOUR_SUMSUB_APP_TOKEN';      // sbx:... for sandbox
const SUMSUB_SECRET_KEY = 'YOUR_SUMSUB_SECRET_KEY';    // Secret signing key
const SUMSUB_BASE_URL = 'https://api.sumsub.com';      // API endpoint
```

--------------------------------

### sign_request(request)

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Prepares a request by injecting HMAC-SHA256 authentication headers including X-App-Token, X-App-Access-Ts, and X-App-Access-Sig.

```APIDOC
## sign_request(request)

### Description
Prepares a request by injecting HMAC-SHA256 authentication headers. This function handles the timestamp generation and signature calculation required for SumSub API authentication.

### Signature
`def sign_request(request: requests.Request) -> requests.PreparedRequest`

### Parameters
- **request** (requests.Request) - Required - The unsigned request object to be prepared.

### Returns
- **requests.PreparedRequest** - The request object with authentication headers added.

### Headers Added
- **X-App-Token** - Application token
- **X-App-Access-Ts** - Current Unix timestamp
- **X-App-Access-Sig** - Hex-encoded HMAC-SHA256 signature

### Example
```python
req = requests.Request('GET', 'https://api.sumsub.com/resources/applicants/123/status')
signed = sign_request(req)
response = requests.Session().send(signed, timeout=60)
```
```

--------------------------------

### Define main orchestration function

Source: https://github.com/sumsubstance/apptokenusageexamples/blob/master/_autodocs/api-reference/python.md

Defines the entry point for the KYC workflow orchestration.

```python
def main()
```
Tokens:
Raw