Skip to main content
POST
/
api
/
v1
/
submit
/
create-user
{
  "email": "<string>",
  "externalUserId": "<string>",
  "id": "<string>",
  "info": {
    "addresses": [
      {
        "country": "<string>",
        "postCode": "<string>",
        "state": "<string>",
        "street": "<string>",
        "town": "<string>"
      }
    ],
    "companyInfo": {
      "beneficiaries": [
        {
          "applicantId": "<string>",
          "beneficiaryInfo": {
            "email": "<string>",
            "first_name": "<string>",
            "last_name": "<string>"
          },
          "id": "<string>",
          "shareSize": 123,
          "types": [
            "<string>"
          ]
        }
      ],
      "companyName": "<string>"
    },
    "country": "<string>",
    "dob": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "nationality": "<string>",
    "phone": "<string>"
  },
  "requiredIdDocsStatus": "<string>",
  "review": {
    "attemptCnt": 123,
    "attemptId": "<string>",
    "createDate": "<string>",
    "levelName": "<string>",
    "reviewDate": "<string>",
    "reviewId": "<string>",
    "reviewResult": {
      "buttonIds": [
        "<string>"
      ],
      "rejectLabels": [
        "<string>"
      ],
      "reviewAnswer": "<string>",
      "reviewRejectType": "<string>"
    },
    "reviewStatus": "<string>"
  },
  "reviewResult": {
    "buttonIds": [
      "<string>"
    ],
    "rejectLabels": [
      "<string>"
    ],
    "reviewAnswer": "<string>",
    "reviewRejectType": "<string>"
  },
  "reviewStatus": "<string>",
  "type": "individual"
}

Authorizations

X-Pubkey, X-Timestamp, X-Signature
string
header
required

Headers

X-Pubkey
string
required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

X-Timestamp
string
required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

X-Signature
string
required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

Body

application/json

Byzantine user creation body

Request body for creating a Byzantine user

email
string
required
externalUserId
string
required
userInfo
object
required

Response

User created successfully

email
string | null
externalUserId
string | null
id
string | null
info
object
requiredIdDocsStatus
string | null
review
object
reviewResult
object
reviewStatus
string | null
type
enum<string>

Type of applicant for Sumsub verification

Available options:
individual,
company
I