Sumsub

https://docs.sumsub.com/
Admin
Sumsub provides a comprehensive platform for businesses to manage identity verification, fraud...
Tokens:1,551,085
Snippets:11,273
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Minimal Device Intelligence setup

Source: https://docs.sumsub.com/reference/get-started-with-device-intelligence

A complete example showing the initialization, fingerprinting, and cleanup flow within a login handler.

```javascript
import { init, destroy } from '@sumsub/fisherman'

const fisherman = await init({ token })

const handleLoginSubmit = async () => {
await fisherman.fingerprint();

// Confirm applicant platform event

destroy();

// Redirect user
}
```

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

### Install dependencies

Source: https://docs.sumsub.com/docs/flutter-plugin

Run the flutter pub get command to install the added dependency.

```shell
flutter pub get
```

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

### cURL Request Example

Source: https://docs.sumsub.com/reference/transaction-creation

Example of a POST request to create a transaction.

```Shell
curl --request POST \
     --url https://api.sumsub.com/resources/applicants/applicantId/kyt/txns/-/data \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"type":"finance"}'
```

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

### Correct Applicant Object Example

Source: https://docs.sumsub.com/reference/submit-transaction-for-existing-applicant

Example of a correctly formatted applicant object when an applicant ID is not provided.

```JSON
"applicant": {  
    "type": "individual",  
    "externalUserId": "PlatformEvent0001",  
    "fullName": "User fullname"  
}
```

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

### Transaction Data Structure Example

Source: https://docs.sumsub.com/reference/transaction-creation

A JSON object representing the structure for transaction creation, including nested objects for counterparty address, institution info, payment methods, device details, and custom properties.

```json
      "town": "cpTown",  // City, town, or another settlement.
      "state": "cpState",  // State, region, district, county or another territorial entity inside a country.
      "street": "cpStreet",  // Street name.
      "subStreet": "cpSubStreet",  // Additional information related to the street. This could be a house number or any other details.
      "flatNumber": "303",  // Flat or apartment number.
      "buildingNumber": "404",  // Building number.
      "buildingName": "cpBuildingName",  // Building name.
      "formattedAddress": "postCode, town, state, street, buildingNumber"  // Address in a human readable format.
    },
    "institutionInfo": {  // Information about the financial institution engaged in performing this transaction on the counterparty side.
      "address": {  // Counterparty institution address.
        "country": "PAN"  // Counterparty institution country. Presented in Alpha-3 code.
      },
      "code": "BIC",  // Counterparty institution code (e.g. BIC).
      "name": "Wells Fargo",  // Counterparty institution name (e.g. Wells Fargo).
      "internalId": "vaspInternalId"  // VASP identifier for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval.
    },
    "paymentMethod": {  // Required object for a crypto check. Information about the payment method used within the transaction.
      "type": "crypto",  // Payment method type, e.g. 'card', 'bank account', 'crypto'.
      "accountId": "cpWalletAddress",  // Required. Unique identifier of the payment method such as an account number, IBAN, crypto wallet address, etc.
      "issuingCountry": "SVN"  // Alpha-3 code of the country that issued the payment method.
    },   
    "device": {  // Information about the counterparty device.
      "ipInfo": {  // Information about the counterparty device location.
        "lat": 600,  // Latitude value in decimal degrees.
        "lon": 700,  // Longitude value  in decimal degrees.
        "ip": "62.228.108.249",  // Counterparty IP address.
        "countryCode3": "SJM"  // Country of the device location per ISO 3166.
      },
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9",  // String with the HTTP header that your web browser sends to each requested page.
      "sessionId": "r-v3-812412m9e12d42",  // Transaction session identifier.
      "sessionAgeMs": 18,  // Session lifetime in milliseconds.
      "acceptLang": "en",  // Language used during an online session (e.g. eng).
      "fingerprint": "cpDevFing"  // Device fingerprint.
    }
  },
  "props": { // Custom properties.
    "customProperty": "Custom value",  // Custom property 1.
    "dailyOutLimit": "10000"  // Custom property 2.
  }
}
```

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

### Get video call media cURL request

Source: https://docs.sumsub.com/reference/get-video-call-media

Example of a GET request to retrieve video call media using cURL, requiring authentication headers.

```bash
curl -X GET \
	   'https://api.sumsub.com/resources/videoIdent/applicant/5e9412223cc1813b4db0b0e3/media/62e38aa5fd6916000172dc23' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'
```

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

### Initialize and Launch SumSub SDK

Source: https://docs.sumsub.com/docs/react-native-module

Initialize the SDK with an access token and optional handlers, then launch the verification flow.

```javascript
import SNSMobileSDK from '@sumsub/react-native-mobilesdk-module';

// ...

let launchSNSMobileSDK = () => {

  // From your backend get an access token for the applicant to be verified.
  // The token must be generated with `levelName` and `userId`,
  // where `levelName` is the name of a level configured in your dashboard.
  //
  // The sdk will work in the production or in the sandbox environment
  // depend on which one the `accessToken` has been generated on.
  //
  let accessToken = "your_access_token";

  let snsMobileSDK = SNSMobileSDK.init(accessToken, () => {
      // this is a token expiration handler, will be called if the provided token is invalid or got expired
      // call your backend to fetch a new access token (this is just an example)
      return fetch('http://example.org/', {
        method: 'GET',
      }).then(resp => {
        // return a fresh token from here
        return 'new_access_token'
      })
    })
    .withHandlers({ // Optional callbacks you can use to get notified of the corresponding events
      onStatusChanged: (event) => {
        console.log("onStatusChanged: [" + event.prevStatus + "] => [" + event.newStatus + "]");
      },
      onLog: (event) => {
        console.log("onLog: [Idensic] " + event.message);
      }
    })
    .withDebug(true)
    .withLocale('en') // Optional, for cases when you need to override the system locale
    .build();

  snsMobileSDK.launch().then(result => {
    console.log("SumSub SDK State: " + JSON.stringify(result))
  }).catch(err => {
    console.log("SumSub SDK Error: " + JSON.stringify(err))
  });
}
```

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

### Initialize and Launch Sumsub SDK

Source: https://docs.sumsub.com/docs/cordova-plugin

Initialize the SDK with an access token and launch the verification process. The SDK supports token expiration handling and status change callbacks.

```javascript
// From your backend, get an access token for the applicant to be verified.
// The token must be generated with `levelName` and `userId`,
// where `levelName` is the name of a level configured in your dashboard.
//
// The SDK will work in the production or in the sandbox environment
// depend on which one the `accessToken` has been generated on.
//
let accessToken = 'your_access_token';

let snsMobileSDK = SNSMobileSDK.init(accessToken, () => {
    // this is a token expiration handler. It will be called if the provided token is invalid or got expired
    // call your backend to fetch a new access token (this is just an example)
    return new Promise((resolve, reject) => {
        resolve('new_access_token')
    })
  })
  .withHandlers({ // Optional callbacks you can use to get notified of the corresponding events
    onStatusChanged: (event) => {
      console.log("onStatusChanged: [" + event.prevStatus + "] => [" + event.newStatus + "]");
    }
  })
  .withDebug(true)
  .withLocale('en') // Optional, for cases when you need to override the system locale
  .build();

snsMobileSDK.launch().then(result => {
  console.log("Sumsub SDK State: " + JSON.stringify(result))
}).catch(err => {
  console.log("Sumsub SDK Error: " + JSON.stringify(err))
});
```

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

### Get status of verification steps cURL request

Source: https://docs.sumsub.com/reference/get-applicant-verification-steps-status

Example request to retrieve the status of required identification documents for a specific applicant using the GET method.

```bash
curl -X GET \
	'https://api.sumsub.com/resources/applicants/5bb8cca10a975a624903cf65/requiredIdDocsStatus' \
  -H 'X-App-Token: <your-app-token>' \
  -H 'X-App-Access-Sig: <your-signature>' \
  -H 'X-App-Access-Ts: <unix-timestamp>'
```

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

### Get signed documents API response

Source: https://docs.sumsub.com/docs/qes-integration-guide

Example of the HTTP response received when calling the Get signed documents API, which returns the binary content of the signed document.

```http
HTTP/1.1 200 OK
Date: Wed, 13 Nov 2024 10:44:38 GMT
Content-Type: application/pdf
Content-Length: 239371
Connection: keep-alive
x-correlation-id: 85e3033ee12d196b8400322e03e47b36
Content-Encoding: identity
content-disposition: attachment; filename=Terms+And+Conditions.pdf
 
<Binary content representing the signed document>
```

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

### Standalone WebSDK 2.0 Initialization

Source: https://docs.sumsub.com/docs/get-started-with-web-sdk

A complete HTML example for initializing WebSDK 2.0 via CDN. Replace $ACCESS_TOKEN with your actual token.

```HTML
<html>
    <head>
        <title>WebSDK CDN Example</title>
    </head>
    <body>
        <script src="https://static.sumsub.com/idensic/static/sns-websdk-builder.js"></script>
        <div id="sumsub-websdk-container"></div>
    </body>
</html>

<script>
function launchWebSdk(accessToken, applicantEmail, applicantPhone) {
    let snsWebSdkInstance = snsWebSdk
        .init(accessToken, () => this.getNewAccessToken())
        .withConf({
            lang: "en",
            email: applicantEmail,
            phone: applicantPhone,
        })
        .withOptions({ addViewportTag: false, adaptIframeHeight: true })
        .on("idCheck.onStepCompleted", (payload) => {
            console.log("onStepCompleted", payload);
        })
        .on("idCheck.onError", (error) => {
            console.log("onError", error);
        })
        .onMessage((type, payload) => {
            console.log("onMessage", type, payload);
        })
        .build();
    snsWebSdkInstance.launch("#sumsub-websdk-container");
}

// Requests a new access token from the backend side.
function getNewAccessToken() {
    return Promise.resolve($NEW_ACCESS_TOKEN);
}

launchWebSdk($ACCESS_TOKEN);
</script>
```

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

### Initialize and launch Sumsub WebSDK

Source: https://docs.sumsub.com/docs/configure-verification-levels

Use this code to initialize the WebSDK with an access token and launch it within a specified container element. The token update callback must return a Promise.

```javascript
import snsWebSdk from '@sumsub/websdk';

/**
 * @param accessToken - access token that you generated
 * on the backend with levelName: sumsub-signin-demo-level
 */
function launchWebSdk(accessToken) {
  let snsWebSdkInstance = snsWebSdk.init(
      accessToken,
      // token update callback, must return Promise
      () => this.getNewAccessToken()
    )
    .withConf({
      //language of WebSDK texts and comments (ISO 639-1 format)
      lang: 'en',
    })
    .on('onError', (error) => {
      console.log('onError', payload)
    })
    .onMessage((type, payload) => {
      console.log('onMessage', type, payload)
    })
    .build();

  // you are ready to go:
  // just launch the WebSDK by providing the container element for it
  snsWebSdkInstance.launch('#sumsub-websdk-container')
}
```

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

### Get case notes via cURL

Source: https://docs.sumsub.com/reference/get-case-notes

Example request to retrieve case notes using the GET method. Requires authentication headers including X-App-Token, X-App-Access-Sig, and X-App-Access-Ts.

```bash
curl -X GET \
     'https://api.sumsub.com/resources/api/caseManagement/v2/cases/notes?caseId=69818ec8a5197bfa820ef2a3&offset=0&limit=100' \
     -H 'accept: application/json' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-request-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'
```

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

### cURL Request for Get Cases by Filter

Source: https://docs.sumsub.com/reference/get-cases-by-filters

A multi-part cURL request example for the cases by filter endpoint.

```Shell
curl --request POST \
```

```Shell
     --url 'https://api.sumsub.com/resources/api/caseManagement/v2/cases/byFilter?offset=0&limit=100' \
```

```Shell
     --header 'content-type: application/json'
```

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

### Install iOS Pods

Source: https://docs.sumsub.com/docs/react-native-module

Run the pod installation command after configuring the Podfile.

```sh
npx pod-install
```

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

### Get face authentication results response example

Source: https://docs.sumsub.com/reference/face-authentication

This JSON response example shows the structure of face authentication results, including the applicant action ID, review status, and specific check results for liveness and face matching.

```JSON
{
  // An applicant action ID - that's what you should get from the WebSDK or MobileSDK.
  "id" : "5d9f76507edd7d8162bfcea8",
  "createdAt" : "2019-10-10 18:20:00",
  "applicantId" : "5d9f74a27edd7d813405fe07",
  "type" : "selfieAuth",
  "review": {
    "reviewResult" : {
      "reviewAnswer" : "GREEN"
    },
  },
  // checks performed: Liveness and comparison with the relevant document
  // NOTE: if the Liveness check didn't pass, we won't perform a face match check.
  "checks" : [ {
    "answer" : "GREEN",
    "checkType" : "FACE_LIVELINESS",
    "createdAt" : "2019-10-10 18:19:57",
    "livenessInfo": {
      "livenessData": {
        "images": [
          {
            "imageId": 1368276695
          },
          {
            "imageId": 1060469685
          },
          {
            "imageId": 2074791000
          },
          {
            "imageId": 810045545
          },
          {
            "imageId": 1328042852
          }
         ]
        },
        "livenessResult": {
          "answer": "GREEN"
          }
        }
  },
  {
    "answer" : "GREEN",
    "checkType" : "FACE_MATCH",
    "createdAt" : "2019-10-10 18:20:00",
    "faceMatchInfo" : {
      "answer" : "GREEN",
    }
  } ]
}
```

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

### Initialize WebSDK 2.0

Source: https://docs.sumsub.com/docs/get-started-with-web-sdk

Initialize the WebSDK 2.0 instance with an access token and configuration options.

```javascript
/**
 * @param accessToken - access token that you generated on the backend
 */
function launchWebSdk(accessToken) {
    let snsWebSdkInstance = snsWebSdk
        .init(
            accessToken,
            // token update callback, must return Promise
            // Access token expired
            // get a new one and pass it to the callback to re-initiate the WebSDK
            () => this.getNewAccessToken()
        )
        .withConf({
            lang: "en", //language of WebSDK texts and comments (ISO 639-1 format)
            theme: "dark" | "light",
        })
        .withOptions({ addViewportTag: false, adaptIframeHeight: true })
        // see below what kind of messages WebSDK generates
        .on("idCheck.onStepCompleted", (payload) => {
            console.log("onStepCompleted", payload);
        })
        .on("idCheck.onError", (error) => {
            console.log("onError", error);
        })
        .build();

    // you are ready to go:
    // just launch the WebSDK by providing the container element for it
    snsWebSdkInstance.launch("#sumsub-websdk-container");
}

function getNewAccessToken() {
    return Promise.resolve(newAccessToken); // get a new token from your backend
}
```

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

### Present SDK on Key Window

Source: https://docs.sumsub.com/docs/get-started-ios

Present the SDK on the key window root view controller.

```Swift
sdk.present()
```

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

### cURL Request Example

Source: https://docs.sumsub.com/reference/get-phone-confirmation-check-results

A cURL command to perform a GET request to retrieve the latest phone confirmation check results.

```bash
curl --request GET \
     --url 'https://api.sumsub.com/resources/checks/latest?type=PHONE_CONFIRMATION'
```

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

### Install Cordova plugin with usage descriptions

Source: https://docs.sumsub.com/docs/cordova-plugin

Install the plugin while providing mandatory usage descriptions for camera, microphone, photo library, and location access.

```shell
cordova plugin add @sumsub/cordova-idensic-mobile-sdk-plugin \
  --variable CAMERA_USAGE="Let us take a photo" \
  --variable MICROPHONE_USAGE="Time to record a video" \
  --variable PHOTO_USAGE="Let us pick a photo" \
  --variable LOCATION_USAGE="Please provide us with your geolocation data to prove your current location
```

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

### cURL Request for Email Confirmation Check

Source: https://docs.sumsub.com/reference/get-email-confirmation-check-results

Example cURL command to perform a GET request to the email confirmation check endpoint.

```bash
curl --request GET \
     --url 'https://api.sumsub.com/resources/checks/latest?type=EMAIL_CONFIRMATION'
```

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

### Standalone WebSDK 1.0 Initialization

Source: https://docs.sumsub.com/docs/get-started-with-web-sdk

A complete HTML example for initializing WebSDK 1.0 via CDN, including custom CSS and i18n configuration.

```HTML
<html>
    <head>
        <title>WebSDK CDN Example</title>
    </head>
    <body>
        <script src="https://static.sumsub.com/idensic/static/sns-websdk-builder.js"></script>
        <div id="sumsub-websdk-container"></div>
    </body>
</html>

<script>
function launchWebSdk(accessToken, applicantEmail, applicantPhone) {
    let snsWebSdkInstance = snsWebSdk
        .init(accessToken, () => this.getNewAccessToken())
        .withConf({
            lang: "en",
            email: applicantEmail,
            phone: applicantPhone,
            i18n: { document: { subTitles: { IDENTITY: "Upload a document that proves your identity" } } },
            onMessage: (type, payload) => {
                console.log("WebSDK onMessage", type, payload);
            },
            uiConf: {
                customCssStr:
                    ":root {\n  --black: #000000;\n   --grey: #F5F5F5;\n  --grey-darker: #B2B2B2;\n  --border-color: #DBDBDB;\n}\n\np {\n  color: var(--black);\n  font-size: 16px;\n  line-height: 24px;\n}\n\nsection {\n  margin: 40px auto;\n}\n\ninput {\n  color: var(--black);\n  font-weight: 600;\n  outline: none;\n}\n\nsection.content {\n  background-color: var(--grey);\n  color: var(--black);\n  padding: 40px 40px 16px;\n  box-shadow: none;\n  border-radius: 6px;\n}\n\nbutton.submit,\nbutton.back {\n  text-transform: capitalize;\n  border-radius: 6px;\n  height: 48px;\n  padding: 0 30px;\n  font-size: 16px;\n  background-image: none !important;\n  transform: none !important;\n  box-shadow: none !important;\n  transition: all 0.2s linear;\n}\n\nbutton.submit {\n  min-width: 132px;\n  background: none;\n  background-color: var(--black);\n}\n\n.round-icon {\n  background-color: var(--black) !important;\n  background-image: none !important;\n}",
            },
            onError: (error) => {
                console.error("WebSDK onError", error);
            },
        })
        .withOptions({ addViewportTag: false, adaptIframeHeight: true })
        .on("idCheck.stepCompleted", (payload) => {
            console.log("stepCompleted", payload);
        })
        .on("idCheck.onError", (error) => {
            console.log("onError", error);
        })
        .onMessage((type, payload) => {
            console.log("onMessage", type, payload);
        })
        .build();
    snsWebSdkInstance.launch("#sumsub-websdk-container");
}

// Requests a new access token from the backend side.
function getNewAccessToken() {
    return Promise.resolve($NEW_ACCESS_TOKEN);
}

launchWebSdk($ACCESS_TOKEN);
</script>
```

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

### Initialize WebSDK 1.0

Source: https://docs.sumsub.com/docs/get-started-with-web-sdk

Initialize the WebSDK 1.0 instance with an access token and custom configuration.

```javascript
/**
 * @param accessToken - access token that you generated on the backend
 * @param customI18nMessages - customized locale messages for current session (not required)
 */
function launchWebSdk(accessToken, customI18nMessages) {
    let snsWebSdkInstance = snsWebSdk
        .init(
            accessToken,
            // token update callback, must return Promise
            // Access token expired
            // get a new one and pass it to the callback to re-initiate the WebSDK
            () => this.getNewAccessToken()
        )
        .withConf({
            lang: "en", //language of WebSDK texts and comments (ISO 639-1 format)
            i18n: customI18nMessages, //JSON of custom SDK Translations
            uiConf: {
                customCss: "https://url.com/styles.css",
                // URL to css file in case you need change it dynamically from the code
                // the similar setting at Customizations tab will rewrite customCss
                // you may also use to pass string with plain styles `customCssStr:`
            },
        })
        .withOptions({ addViewportTag: false, adaptIframeHeight: true })
        // see below what kind of messages WebSDK generates
        .on("idCheck.stepCompleted", (payload) => {
            console.log("stepCompleted", payload);
        })
        .on("idCheck.onError", (error) => {
            console.log("onError", error);
        })
        .build();

    // you are ready to go:
    // just launch the WebSDK by providing the container element for it
    snsWebSdkInstance.launch("#sumsub-websdk-container");
}

function getNewAccessToken() {
    return Promise.resolve(newAccessToken); // get a new token from your backend
}
```

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

### cURL Request for Applicant Actions

Source: https://docs.sumsub.com/reference/get-applicant-actions

Example cURL command to retrieve applicant actions using the GET method with limit and offset parameters.

```shell
curl --request GET \
```

```shell
     --url 'https://api.sumsub.com/resources/applicantActions/-;applicantId=applicantId?limit=1000&offset=0'
```

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

### cURL request to get video call data

Source: https://docs.sumsub.com/reference/get-video-call-data

Example request using cURL to fetch video identification data for a specific inspection ID.

```bash
curl -X GET \
     'https://api.sumsub.com/resources/inspections/inspectionId?fields=videoIdentData' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'
```

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

### Install React SDK

Source: https://docs.sumsub.com/docs/get-started-with-web-sdk

Import the Sumsub Web SDK component for React applications.

```Shell
import SumsubWebSdk from '@sumsub/websdk-react'
```

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

### cURL Request for Company Tax Check

Source: https://docs.sumsub.com/reference/get-company-tax-check-results

Example of a GET request to retrieve the latest company tax check results using an applicant ID.

```bash
curl -X GET \
     'https://api.sumsub.com/resources/checks/latest?applicantId=63e096c51b6b4030f2e01154&type=COMPANY_TAX' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'
```
Tokens:
Raw