---
updatedAt: 2026-09-29T07:40:57.000Z
agentTools:
  projectIndex: https://docs.sumsub.com/llms.txt
---

# Preview profile before copying

# Overview

Use this method to retrieve a preview of an applicant profile before performing the actual import into the recipient key using the [Copy applicant profile](https://docs.sumsub.com/sumsub/reference/copy-applicant-profile) method.

For example, you want to check the [applicant status](https://docs.sumsub.com/sumsub/docs/applicant-statuses) first and proceed with the copy only if the applicant is approved.

<Callout icon="📘" theme="info">
  ### Note

  You can reuse the same `shareToken` — for example, first with the preview endpoint and then with the actual applicant copy method.
</Callout>

## Required permissions

To use this method, your [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) must have the **Create applicants** [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions).

# Request example

```curl
curl -X GET \
     'https://api.sumsub.com/resources/applicants/-/import/preview?shareToken=_act-jwt-lokijuhygtJub25lIn0.eyJqdGkiOiJfYWN0LTc4ZDNlYjRkLWQ3Y2EtNDFhYS05N2Y2LTYxMjU4ODQ3YTRmZSIsInVybCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA5MCJ9.' \
     -H 'Authorization: Bearer token' \
     -H 'X-App-Token: <your-app-token>' \
     -H 'X-App-Access-Sig: <your-signature>' \
     -H 'X-App-Access-Ts: <unix-timestamp>'
```

# Response explained

The response is a JSON file representing the applicant profile data and applicant status. You can see the response structure, possible content with descriptions, and examples on the [following page](https://docs.sumsub.com/sumsub/reference/get-applicant-data#response-explained).

<Callout icon="📘" theme="info">
  ### Note

  The response returns only the applicant's current status and review data. It does not include document images and results of specific checks.
</Callout>

# Response example

If the request is successfully sent and processed, you will get a response like the one below.

```json
{
    "id": "6908992ea9c4d8125fr78u69",
    "createdAt": "2025-11-03 11:59:42",
    "clientId": "cool_client_id",
    "inspectionId": "6908992ea9c4d8548ddfr47y",
    "externalUserId": "preview-random-0000000000",
    "info": {
        "firstName": "John",
        "firstNameEn": "John",
        "lastName": "Mock-Doe",
        "lastNameEn": "Mock-Doe",
        "aliasName": "Mock aliasName",
        "dob": "2006-05-07",
        "country": "DEU",
        "idDocs": [
            {
                "idDocType": "ID_CARD",
                "country": "DEU",
                "firstName": "John",
                "firstNameEn": "John",
                "lastName": "Mock-Doe",
                "lastNameEn": "Mock-Doe",
                "aliasName": "Mock aliasName",
                "issuedDate": "2016-02-04",
                "validUntil": "2026-10-25",
                "number": "Mock-HXND7AYHVE",
                "dob": "2006-05-07",
                "mrzLine1": "I<IRL44QI4ZXXXX<<<<<<<<<<<<<<<",
                "mrzLine2": "0812236M2806170IRL<<<<<<<<<<<2",
                "mrzLine3": "DOE<<JOHN<<<<<<<<<<<<<<<<<<<",
                "termless": false
            }
        ]
    },
    "email": "example@examplemail.com",
    "applicantPlatform": "Web",
    "agreement": {
        "items": [
            {
                "id": "e19145b7-319f-4cbc-8061-fffc3dc7d4a3",
                "acceptedAt": "2025-11-03 12:00:12",
                "source": "WebSDK",
                "type": "onboarding",
                "recordIds": [
                    "684fc8717056c9d53e87ed95"
                ]
            }
        ],
        "createdAt": "2025-11-03 12:00:12",
        "acceptedAt": "2025-11-03 12:00:12",
        "source": "WebSDK",
        "recordIds": [
            "684fc8717056c9d53e87ed95"
        ]
    },
    "requiredIdDocs": {
        "docSets": [
            {
                "idDocSetType": "IDENTITY",
                "types": [
                    "DRIVERS",
                    "ID_CARD",
                    "RESIDENCE_PERMIT",
                    "PASSPORT"
                ],
                "videoRequired": "disabled",
                "nfcVerificationSettings": {
                    "mode": "disabled"
                }
            },
            {
                "idDocSetType": "SELFIE",
                "types": [
                    "SELFIE"
                ],
                "videoRequired": "passiveLiveness"
            }
        ]
    },
    "review": {
        "reviewId": "KQJFd",
        "attemptId": "tEtNo",
        "attemptCnt": 1,
        "elapsedSincePendingMs": 1342,
        "elapsedSinceQueuedMs": 1342,
        "reprocessing": true,
        "levelName": "kyc-basic-level",
        "createDate": "2025-11-03 12:01:36+0000",
        "reviewDate": "2025-11-03 12:01:37+0000",
        "reviewResult": {
            "reviewAnswer": "GREEN"
        },
        "reviewStatus": "completed",
        "priority": 0
    },
    "lang": "en",
    "type": "individual"
}
```

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

```json
{
  "code": 401,
  "correlationId": "2f6ffcee33152ae571139b2537fc2359",
  "description": "Token is invalid, make sure you generate a new one each time, because the old ones are invalidated upon usage"
}
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "sumsub-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.sumsub.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "X-App-Token",
        "in": "header",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/resources/applicants/-/import/preview": {
      "get": {
        "summary": "Preview profile before copying",
        "description": "",
        "operationId": "preview-profile-before-copying",
        "parameters": [
          {
            "name": "shareToken",
            "in": "query",
            "description": "A unique share token you receive from your partner. <br><br>You can generate a share token for your partners using the [following method](https://docs.sumsub.com/sumsub/reference/generate-share-token).",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer token"
            }
          }
        ],
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```