Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.sumsub.com
/resources/applicants/{applicantId}/info/companyInfo/beneficiaries/{beneficiaryApplicantId}
Removes the applicant from the list of company beneficial owners.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| applicantId | path | required | string | A unique company applicant identifier. |
| beneficiaryApplicantId | path | required | string | Beneficiary applicant identifier. |
DELETE /resources/applicants/{applicantId}/info/companyInfo/beneficiaries/{beneficiaryApplicantId}
/resources/applicants/{applicantId}/tags
Removes all custom tags from applicant profiles.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| applicantId | path | required | string | A unique applicant identifier. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicantRemoveCustomTagsRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ApplicantRemoveCustomTagsRequest1"
}
}
}
}
DELETE /resources/applicants/{applicantId}/tags
/resources/inspections/{inspectionId}/resources/{imageId}
Marks uploaded images as deleted.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| revert | query | optional | boolean | Set `true` to revert inactivity of the image. |
| inspectionId | path | required | string | An inspection identifier. You can get this number by using [this API method](ref:get-applicant-data). |
| imageId | path | required | string | An image identifier. You can get this number by using [this API method](ref:get-applicant-verification-steps-status). |
DELETE /resources/inspections/{inspectionId}/resources/{imageId}
/resources/kyt/txns/notes
Removes notes from transactions.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteRemoveFromTransactionRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/NoteRemoveFromTransactionRequest1"
}
}
}
}
DELETE /resources/kyt/txns/notes
/resources/kyt/txns/{id}/tags
Removes tags from transactions.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A unique transaction identifier. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionRemoveTagsRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/TransactionRemoveTagsRequest1"
}
}
}
}
DELETE /resources/kyt/txns/{id}/tags
AccessTokenConfirmPlatformEventRequest
{
"type": "object",
"required": [
"applicant",
"userPlatformEventInfo",
"txnId"
],
"properties": {
"txnId": {
"type": "string",
"description": "Unique identifier for the confirmed applicant platform event that you generate on your side."
},
"applicant": {
"type": "object",
"required": [
"fullName",
"externalUserId"
],
"properties": {
"fullName": {
"type": "string",
"description": "Full name of the applicant."
},
"externalUserId": {
"type": "string",
"description": "A unique applicant identifier within your system."
}
},
"description": "Applicant's full name and identifier on your side."
},
"userPlatformEventInfo": {
"type": "object",
"properties": {
"failure": {
"type": "boolean",
"description": "Indicates whether the event on the applicant side was successful or not. <ul><li><code>true</code> — event failed (e.g. wrong credentials provided when logging in, or incorrect data submitted when resetting password).</li><li><code>false</code> — event was successful.</li></ul>"
}
},
"description": "Indicates the applicant platform event status. Can be omitted if the event was successful."
}
}
}
AccessTokenConfirmPlatformEventRequest1
{
"type": "object",
"required": [
"applicant",
"userPlatformEventInfo",
"txnId"
],
"properties": {
"txnId": {
"type": "string",
"description": "Unique identifier for the confirmed applicant platform event that you generate on your side."
},
"applicant": {
"type": "object",
"required": [
"fullName",
"externalUserId"
],
"properties": {
"fullName": {
"type": "string",
"description": "Full name of the applicant."
},
"externalUserId": {
"type": "string",
"description": "A unique applicant identifier within your system."
}
},
"description": "Applicant's full name and identifier on your side."
},
"userPlatformEventInfo": {
"type": "object",
"properties": {
"failure": {
"type": "boolean",
"description": "Indicates whether the event on the applicant side was successful or not. <ul><li><code>true</code> — event failed (e.g. wrong credentials provided when logging in, or incorrect data submitted when resetting password).</li><li><code>false</code> — event was successful.</li></ul>"
}
},
"description": "Indicates the applicant platform event status. Can be omitted if the event was successful."
}
}
}
AccessTokenGenerateFishermanTokenRequest
{
"type": "object",
"required": [
"sessionId",
"userPlatformEventType"
],
"properties": {
"sessionId": {
"type": "string",
"description": "A unique identifier of the applicant session."
},
"ttlInSecs": {
"type": "integer",
"format": "int32",
"default": 1800,
"description": "A lifespan of a token in seconds. Default value is 1800 seconds."
},
"userPlatformEventType": {
"type": "string",
"description": "An event that occurred on the applicant device as a result of the interaction with the application UI. <br><br>The following event types are supported: <ul><li><code>login</code> — applicant logging in.</li><li><code>signup</code> — applicant signing up.</li><li><code>passwordReset</code> — applicant resetting the password.</li><li><code>twoFaReset</code> — applicant resetting two-factor authentication.</li></ul>"
}
}
}
AccessTokenGenerateFishermanTokenRequest1
{
"type": "object",
"required": [
"sessionId",
"userPlatformEventType"
],
"properties": {
"sessionId": {
"type": "string",
"description": "A unique identifier of the applicant session."
},
"ttlInSecs": {
"type": "integer",
"format": "int32",
"default": 1800,
"description": "A lifespan of a token in seconds. Default value is 1800 seconds."
},
"userPlatformEventType": {
"type": "string",
"description": "An event that occurred on the applicant device as a result of the interaction with the application UI. <br><br>The following event types are supported: <ul><li><code>login</code> — applicant logging in.</li><li><code>signup</code> — applicant signing up.</li><li><code>passwordReset</code> — applicant resetting the password.</li><li><code>twoFaReset</code> — applicant resetting two-factor authentication.</li></ul>"
}
}
}
AnalysisStandaloneCryptoInitiationRequest
{
"type": "object",
"required": [
"currency",
"direction",
"address"
],
"properties": {
"txn": {
"type": "string",
"description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
},
"address": {
"type": "string",
"description": "Target address hash."
},
"tokenId": {
"type": "string",
"description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
},
"currency": {
"type": "string",
"description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
},
"direction": {
"type": "string",
"description": "An operation type. Can be `withdrawal` or `deposit`."
}
}
}
AnalysisStandaloneCryptoInitiationRequest1
{
"type": "object",
"required": [
"currency",
"direction",
"address"
],
"properties": {
"txn": {
"type": "string",
"description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
},
"address": {
"type": "string",
"description": "Target address hash."
},
"tokenId": {
"type": "string",
"description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
},
"currency": {
"type": "string",
"description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
},
"direction": {
"type": "string",
"description": "An operation type. Can be `withdrawal` or `deposit`."
}
}
}
ApplicantAddBeneficiaryRequest
{
"type": "object",
"required": [
"applicant",
"applicantId",
"type"
],
"properties": {
"type": {
"enum": [
"ubo",
"shareholder",
"representative",
"director"
],
"type": "string",
"description": "Beneficiary type."
},
"applicant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "applicantId of beneficiary"
}
},
"description": "An object that represents an individual applicant identifier."
},
"positions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of positions in the company (`[\"director\", \"shareholder\", \"other\"]`)."
},
"applicantId": {
"type": "string",
"description": "Beneficiary applicant identifier."
}
}
}
ApplicantAddBeneficiaryRequest1
{
"type": "object",
"required": [
"applicant",
"applicantId",
"type"
],
"properties": {
"type": {
"enum": [
"ubo",
"shareholder",
"representative",
"director"
],
"type": "string",
"description": "Beneficiary type."
},
"applicant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "applicantId of beneficiary"
}
},
"description": "An object that represents an individual applicant identifier."
},
"positions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of positions in the company (`[\"director\", \"shareholder\", \"other\"]`)."
},
"applicantId": {
"type": "string",
"description": "Beneficiary applicant identifier."
}
}
}
ApplicantAddConsentToProfileRequest
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Full raw consent text."
}
}
},
"description": "An array of applicant consents."
},
"acceptedAt": {
"type": "string",
"description": "Date and time a consent was accepted by the applicant."
},
"residenceCountry": {
"type": "string",
"description": "An applicant country of residence in Alpha-3 format. For example, `USA` for the United States of America or `GBR` for Great Britain."
}
}
}
ApplicantAddConsentToProfileRequest1
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Full raw consent text."
}
}
},
"description": "An array of applicant consents."
},
"acceptedAt": {
"type": "string",
"description": "Date and time a consent was accepted by the applicant."
},
"residenceCountry": {
"type": "string",
"description": "An applicant country of residence in Alpha-3 format. For example, `USA` for the United States of America or `GBR` for Great Britain."
}
}
}
ApplicantAddCustomTagsRequest
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
ApplicantAddCustomTagsRequest1
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
ApplicantAddCustomTagsRequest2
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
ApplicantAddCustomTagsRequest3
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
ApplicantAddIdDocumentRequest
{
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "A photo of the document."
},
"metadata": {
"type": "object",
"required": [
"idDocType",
"country"
],
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth."
},
"number": {
"type": "string",
"description": "A document number."
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-3 country code."
},
"lastName": {
"type": "string",
"description": "Last applicant name."
},
"firstName": {
"type": "string",
"description": "First applicant name."
},
"idDocType": {
"type": "string",
"description": "A document type."
},
"issuedDate": {
"type": "string",
"description": "Issued date (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"middleName": {
"type": "string",
"description": "Middle applicant name."
},
"validUntil": {
"type": "string",
"description": "Valid until date (format `YYYY-mm-dd`, e.g. 2001-09-26)."
},
"idDocSubType": {
"type": "string",
"description": "`FRONT_SIDE`, `BACK_SIDE` or `null`."
},
"placeOfBirth": {
"type": "string",
"description": "Applicant birthplace."
}
},
"description": "An object that represents an ID document."
}
}
}
ApplicantAddIdDocumentRequest1
{
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "A photo of the document."
},
"metadata": {
"type": "object",
"required": [
"idDocType",
"country"
],
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth."
},
"number": {
"type": "string",
"description": "A document number."
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-3 country code."
},
"lastName": {
"type": "string",
"description": "Last applicant name."
},
"firstName": {
"type": "string",
"description": "First applicant name."
},
"idDocType": {
"type": "string",
"description": "A document type."
},
"issuedDate": {
"type": "string",
"description": "Issued date (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"middleName": {
"type": "string",
"description": "Middle applicant name."
},
"validUntil": {
"type": "string",
"description": "Valid until date (format `YYYY-mm-dd`, e.g. 2001-09-26)."
},
"idDocSubType": {
"type": "string",
"description": "`FRONT_SIDE`, `BACK_SIDE` or `null`."
},
"placeOfBirth": {
"type": "string",
"description": "Applicant birthplace."
}
},
"description": "An object that represents an ID document."
}
}
}
ApplicantAddImageToPaymentMethodRequest
{
"type": "object",
"required": [
"content",
"metadata"
],
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "A document photo."
},
"metadata": {
"type": "object",
"required": [
"idDocType",
"country"
],
"properties": {
"country": {
"type": "string"
},
"idDocType": {
"type": "string"
}
},
"description": "An object representing a payment method."
}
}
}
ApplicantAddImageToPaymentMethodRequest1
{
"type": "object",
"required": [
"content",
"metadata"
],
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "A document photo."
},
"metadata": {
"type": "object",
"required": [
"idDocType",
"country"
],
"properties": {
"country": {
"type": "string"
},
"idDocType": {
"type": "string"
}
},
"description": "An object representing a payment method."
}
}
}
ApplicantAddPaymentMethodInformationRequest
{
"type": "object",
"required": [
"type"
],
"properties": {
"data": {
"type": "object",
"properties": {
"requiredIdDoc": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"txnAmount": {
"type": "string"
},
"issuedDate": {
"type": "string"
},
"middleName": {
"type": "string"
}
}
}
},
"description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
},
"type": {
"type": "string",
"description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
},
"subType": {
"type": "string",
"description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
}
}
}
ApplicantAddPaymentMethodInformationRequest1
{
"type": "object",
"required": [
"type"
],
"properties": {
"data": {
"type": "object",
"properties": {
"requiredIdDoc": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"txnAmount": {
"type": "string"
},
"issuedDate": {
"type": "string"
},
"middleName": {
"type": "string"
}
}
}
},
"description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
},
"type": {
"type": "string",
"description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
},
"subType": {
"type": "string",
"description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
}
}
}
ApplicantChangeCompanyDataRequest
{
"type": "object",
"required": [
"companyName",
"registrationNumber"
],
"properties": {
"type": {
"type": "string",
"description": "Type of entity."
},
"email": {
"type": "string",
"description": "Email address."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"taxId": {
"type": "string",
"description": "Taxpayer registration number/Code of taxpayer registration."
},
"country": {
"type": "string",
"description": "A three-letter country code (e.g. `DEU`)."
},
"website": {
"type": "string",
"description": "Website URL."
},
"addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of addresses."
},
"companyName": {
"type": "string",
"description": "Company name."
},
"legalAddress": {
"type": "string",
"description": "Legal name."
},
"beneficiaries": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "Applicant IDs of beneficiaries and additional info like position and type."
},
"controlScheme": {
"type": "string",
"description": "Description of the control scheme of the group of entities."
},
"postalAddress": {
"type": "string",
"description": "Postal address."
},
"incorporatedOn": {
"type": "string",
"description": "Date of incorporation (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"registrationNumber": {
"type": "string",
"description": "Registration number."
},
"registrationLocation": {
"type": "string",
"description": "Location of registration."
}
}
}
ApplicantChangeCompanyDataRequest1
{
"type": "object",
"required": [
"companyName",
"registrationNumber"
],
"properties": {
"type": {
"type": "string",
"description": "Type of entity."
},
"email": {
"type": "string",
"description": "Email address."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"taxId": {
"type": "string",
"description": "Taxpayer registration number/Code of taxpayer registration."
},
"country": {
"type": "string",
"description": "A three-letter country code (e.g. `DEU`)."
},
"website": {
"type": "string",
"description": "Website URL."
},
"addresses": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of addresses."
},
"companyName": {
"type": "string",
"description": "Company name."
},
"legalAddress": {
"type": "string",
"description": "Legal name."
},
"beneficiaries": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "Applicant IDs of beneficiaries and additional info like position and type."
},
"controlScheme": {
"type": "string",
"description": "Description of the control scheme of the group of entities."
},
"postalAddress": {
"type": "string",
"description": "Postal address."
},
"incorporatedOn": {
"type": "string",
"description": "Date of incorporation (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"registrationNumber": {
"type": "string",
"description": "Registration number."
},
"registrationLocation": {
"type": "string",
"description": "Location of registration."
}
}
}
ApplicantChangeExtractedInfoRequest
{
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"tin": {
"type": "string",
"description": "Tax identification number."
},
"gender": {
"type": "string",
"description": "An applicant gender (`M` or `F`)."
},
"country": {
"type": "string",
"description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"addresses": {
"type": "string",
"description": "List of applicant addresses."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"legalName": {
"type": "string",
"description": "Legal name."
},
"middleName": {
"type": "string",
"description": "The middle name of the applicant."
},
"nationality": {
"type": "string",
"description": "Alpha-3 country code."
},
"placeOfBirth": {
"type": "string",
"description": "The applicant birthplace."
},
"stateOfBirth": {
"type": "string",
"description": "Applicant state of birth."
},
"countryOfBirth": {
"type": "string",
"description": "Applicant country of birth."
}
}
}
ApplicantChangeExtractedInfoRequest1
{
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"tin": {
"type": "string",
"description": "Tax identification number."
},
"gender": {
"type": "string",
"description": "An applicant gender (`M` or `F`)."
},
"country": {
"type": "string",
"description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"addresses": {
"type": "string",
"description": "List of applicant addresses."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"legalName": {
"type": "string",
"description": "Legal name."
},
"middleName": {
"type": "string",
"description": "The middle name of the applicant."
},
"nationality": {
"type": "string",
"description": "Alpha-3 country code."
},
"placeOfBirth": {
"type": "string",
"description": "The applicant birthplace."
},
"stateOfBirth": {
"type": "string",
"description": "Applicant state of birth."
},
"countryOfBirth": {
"type": "string",
"description": "Applicant country of birth."
}
}
}
ApplicantConfirmDataRequest
{
"type": "object",
"properties": {
"otp": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "OTP that was sent to applicant."
}
},
"description": "OTP confirmation data if `confirmationType` is `otp`."
},
"oauth": {
"type": "object",
"required": [
"completeUrl"
],
"properties": {
"completeUrl": {
"type": "string",
"description": "Final redirected URL of the auth journey with query params. Format: `redirectUrl?<queryParams>`."
}
},
"description": "oAuth confirmation data if `confirmationType` is `oAuth`."
}
}
}
ApplicantConfirmDataRequest1
{
"type": "object",
"properties": {
"otp": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"description": "OTP that was sent to applicant."
}
},
"description": "OTP confirmation data if `confirmationType` is `otp`."
},
"oauth": {
"type": "object",
"required": [
"completeUrl"
],
"properties": {
"completeUrl": {
"type": "string",
"description": "Final redirected URL of the auth journey with query params. Format: `redirectUrl?<queryParams>`."
}
},
"description": "oAuth confirmation data if `confirmationType` is `oAuth`."
}
}
}
ApplicantCreateActionRequest
{
"type": "object",
"required": [
"externalActionId"
],
"properties": {
"email": {
"type": "string",
"description": "Applicant email address."
},
"phone": {
"type": "string",
"description": "Applicant phone number."
},
"paymentMethod": {
"type": "object",
"required": [
"type"
],
"properties": {
"data": {
"type": "object",
"properties": {
"requiredIdDoc": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"txnAmount": {
"type": "string"
},
"issuedDate": {
"type": "string"
},
"middleName": {
"type": "string"
}
}
}
},
"description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
},
"type": {
"type": "string",
"description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
},
"subType": {
"type": "string",
"description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
}
},
"description": "Object that represents a specific payment method required from the applicant. You can send the data that will be shown to the user as a hint."
},
"externalActionId": {
"type": "string",
"description": "An external action ID which will be bound to the token."
}
}
}
ApplicantCreateActionRequest1
{
"type": "object",
"required": [
"externalActionId"
],
"properties": {
"email": {
"type": "string",
"description": "Applicant email address."
},
"phone": {
"type": "string",
"description": "Applicant phone number."
},
"paymentMethod": {
"type": "object",
"required": [
"type"
],
"properties": {
"data": {
"type": "object",
"properties": {
"requiredIdDoc": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"txnAmount": {
"type": "string"
},
"issuedDate": {
"type": "string"
},
"middleName": {
"type": "string"
}
}
}
},
"description": "An object that represents a payment method. `requiredIdDoc` contains information for comparison with the recognized image data from the applicant."
},
"type": {
"type": "string",
"description": "A payment type. Can be: `bankCard`, `eWallet`, `wireTransfer`."
},
"subType": {
"type": "string",
"description": "A payment subtype. For example, `VISA`, `MASTERCARD`, etc."
}
},
"description": "Object that represents a specific payment method required from the applicant. You can send the data that will be shown to the user as a hint."
},
"externalActionId": {
"type": "string",
"description": "An external action ID which will be bound to the token."
}
}
}
ApplicantCreateCryptoSourceOfFundsRequest
{
"type": "object",
"required": [
"currency",
"direction",
"address"
],
"properties": {
"txn": {
"type": "string",
"description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
},
"address": {
"type": "string",
"description": "Target address hash."
},
"tokenId": {
"type": "string",
"description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
},
"currency": {
"type": "string",
"description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
},
"direction": {
"type": "string",
"description": "Operation type. Can be `withdrawal` or `deposit`."
}
}
}
ApplicantCreateCryptoSourceOfFundsRequest1
{
"type": "object",
"required": [
"currency",
"direction",
"address"
],
"properties": {
"txn": {
"type": "string",
"description": "Transaction hash. For `withdrawals`, `txn` should not be set at all or set to `null`."
},
"address": {
"type": "string",
"description": "Target address hash."
},
"tokenId": {
"type": "string",
"description": "Check the [Get available tokens](ref:get-available-tokens) method to get the full list of available currencies and token IDs."
},
"currency": {
"type": "string",
"description": "`BTC`, `ETH`, `BCH`, `LTC`, `USDT`, `ERC-20`, `BSV`, `XLM`, ..."
},
"direction": {
"type": "string",
"description": "Operation type. Can be `withdrawal` or `deposit`."
}
}
}
ApplicantCreatePaymentSourceActionsRequest
{
"type": "object",
"properties": {
"paymentSource": {
"type": "object",
"properties": {
"fixedInfo": {
"type": "object",
"properties": {
"type": {
"enum": [
"bankCard",
"bankStatement",
"eWallet",
"cryptoWallet"
],
"type": "string",
"description": "A payment source type."
},
"email": {
"type": "string",
"description": "An email address associated with a particular account."
},
"fullName": {
"type": "string",
"description": "The full name of an account holder (e.g., \"Alex Kim\")."
},
"institutionName": {
"type": "string",
"description": "A name of the financial institution where an account is held (e.g., Revolut)."
},
"accountIdentifier": {
"type": "string",
"description": "A unique identifier for an account (e.g., \"123456\")."
}
},
"description": "Additional fixed information related to a payment source."
}
},
"description": "Data on a payment source."
},
"externalActionId": {
"type": "string",
"description": "An external identifier for an action."
}
}
}
ApplicantCreatePaymentSourceActionsRequest1
{
"type": "object",
"properties": {
"paymentSource": {
"type": "object",
"properties": {
"fixedInfo": {
"type": "object",
"properties": {
"type": {
"enum": [
"bankCard",
"bankStatement",
"eWallet",
"cryptoWallet"
],
"type": "string",
"description": "A payment source type."
},
"email": {
"type": "string",
"description": "An email address associated with a particular account."
},
"fullName": {
"type": "string",
"description": "The full name of an account holder (e.g., \"Alex Kim\")."
},
"institutionName": {
"type": "string",
"description": "A name of the financial institution where an account is held (e.g., Revolut)."
},
"accountIdentifier": {
"type": "string",
"description": "A unique identifier for an account (e.g., \"123456\")."
}
},
"description": "Additional fixed information related to a payment source."
}
},
"description": "Data on a payment source."
},
"externalActionId": {
"type": "string",
"description": "An external identifier for an action."
}
}
}
ApplicantCreatePaymentSourceActionsResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "65e9624496bed30142a6d15c"
},
"key": {
"type": "string",
"example": "SBCJVLAAMRHYAB"
},
"review": {
"type": "object",
"properties": {
"reviewId": {
"type": "string",
"example": "RlWfu"
},
"attemptId": {
"type": "string",
"example": "dhABq"
},
"levelName": {
"type": "string",
"example": "paymentSource"
},
"attemptCnt": {
"type": "integer",
"default": 0,
"example": 0
},
"createDate": {
"type": "string",
"example": "2024-03-07T06:44:24.000+00:00"
},
"reviewStatus": {
"type": "string",
"example": "init"
}
}
},
"clientId": {
"type": "string",
"example": "client_id"
},
"createdAt": {
"type": "string",
"example": "2024-03-07 06:44:24"
},
"applicantId": {
"type": "string",
"example": "65e881a212b4ef468def3bbb"
},
"paymentSource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "c4032de1-2e1c-4b29-8a81-623103f9cd51"
},
"createdAt": {
"type": "string",
"example": "2024-03-07 06:44:24"
},
"fixedInfo": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "paymentMethod"
},
"email": {
"type": "string",
"example": "JohnDoe@mail.com"
},
"fullName": {
"type": "string",
"example": "John Doe"
},
"institutionName": {
"type": "string",
"example": "Name"
},
"accountIdentifier": {
"type": "string",
"example": "120834387"
}
}
}
}
},
"requiredIdDocs": {
"type": "object",
"properties": {
"docSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string",
"example": "PAYMENT_SOURCE"
}
},
"idDocSetType": {
"type": "string",
"example": "PAYMENT_METHODS"
}
}
}
}
}
},
"externalActionId": {
"type": "string",
"example": "payment-source-1fbH9AYHn"
}
}
}
ApplicantEnrichTransactionWithTravelRuleDataRequest
{
"type": "object",
"required": [
"fullName"
],
"properties": {
"fullName": {
"type": "string",
"description": "Participant full name."
}
}
}
ApplicantEnrichTransactionWithTravelRuleDataRequest1
{
"type": "object",
"required": [
"fullName"
],
"properties": {
"fullName": {
"type": "string",
"description": "Participant full name."
}
}
}
ApplicantEnrichTransactionWithTravelRuleDataResponse
{
"type": "object",
"properties": {}
}
ApplicantGetDataByExternalUserIdResponse
{
"oneOf": [
{
"type": "object",
"title": "Individual applicants",
"properties": {
"id": {
"type": "string",
"example": "5b594ade0a975a36c9349e66"
},
"info": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"example": "1989-07-16"
},
"idDocs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"example": "1989-07-16"
},
"number": {
"type": "string",
"example": "LGXX359T8"
},
"country": {
"type": "string",
"example": "DEU"
},
"lastName": {
"type": "string",
"example": "SMITH"
},
"mrzLine1": {
"type": "string",
"example": "IDD<<LGXX359T88<<<<<<<<<<<<<<<"
},
"mrzLine2": {
"type": "string",
"example": "8907167<2809045D<<<<<<<<<<<<<8"
},
"mrzLine3": {
"type": "string",
"example": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<"
},
"firstName": {
"type": "string",
"example": "CHRISTIAN"
},
"idDocType": {
"type": "string",
"example": "ID_CARD"
},
"lastNameEn": {
"type": "string",
"example": "SMITH"
},
"validUntil": {
"type": "string",
"example": "2028-09-04"
},
"firstNameEn": {
"type": "string",
"example": "CHRISTIAN"
}
}
}
},
"country": {
"type": "string",
"example": "DEU"
},
"lastName": {
"type": "string",
"example": "SMITH"
},
"firstName": {
"type": "string",
"example": "CHRISTIAN"
},
"lastNameEn": {
"type": "string",
"example": "SMITH"
},
"firstNameEn": {
"type": "string",
"example": "CHRISTIAN"
}
}
},
"lang": {
"type": "string",
"example": "de"
},
"type": {
"type": "string",
"example": "individual"
},
"email": {
"type": "string",
"example": "christman1@gmail.com"
},
"review": {
"type": "object",
"properties": {
"levelName": {
"type": "string",
"example": "basic-kyc"
},
"createDate": {
"type": "string",
"example": "2020-06-24T05:11:02.000+00:00"
},
"reviewDate": {
"type": "string",
"example": "2020-06-24T05:12:58.000+00:00"
},
"reprocessing": {
"type": "boolean",
"default": true,
"example": true
},
"reviewResult": {
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"example": "GREEN"
}
}
},
"reviewStatus": {
"type": "string",
"example": "completed"
},
"elapsedSinceQueuedMs": {
"type": "integer",
"default": 0,
"example": 95785
},
"elapsedSincePendingMs": {
"type": "integer",
"default": 0,
"example": 115879
}
}
},
"clientId": {
"type": "string",
"example": "ClientName"
},
"agreement": {
"type": "object",
"properties": {
"source": {
"type": "string",
"example": "WebSDK"
},
"targets": {
"type": "array",
"items": {
"type": "string",
"example": "By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/)"
}
},
"createdAt": {
"type": "string",
"example": "2020-06-24 04:18:40"
}
}
},
"createdAt": {
"type": "string",
"example": "2020-06-24 05:05:14"
},
"fixedInfo": {
"type": "object",
"properties": {
"lastName": {
"type": "string",
"example": "Smith"
},
"firstName": {
"type": "string",
"example": "Chris"
}
}
},
"inspectionId": {
"type": "string",
"example": "5b594ade0a975a36c9379e67"
},
"externalUserId": {
"type": "string",
"example": "SomeExternalUserId"
},
"requiredIdDocs": {
"type": "object",
"properties": {
"docSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string",
"example": "PASSPORT"
}
},
"idDocSetType": {
"type": "string",
"example": "IDENTITY"
}
}
}
}
}
},
"applicantPlatform": {
"type": "string",
"example": "Android"
}
}
},
{
"type": "object",
"title": "Company applicants",
"properties": {
"id": {
"type": "string",
"example": "5ecfbe9ad5ea48743f8dd1b8"
},
"info": {
"type": "object",
"properties": {
"companyInfo": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "ltd"
},
"country": {
"type": "string",
"example": "GBR"
},
"website": {
"type": "string",
"example": "www.sumsub.com"
},
"companyName": {
"type": "string",
"example": "SUMSUB LIMITED"
},
"beneficiaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "ubo"
},
"imageIds": {},
"applicant": {},
"positions": {
"type": "array",
"items": {
"type": "string",
"example": "director"
}
},
"inRegistry": {
"type": "boolean",
"default": true,
"example": false
},
"applicantId": {
"type": "string",
"example": "5ecfbecad5ea48743f8dd438"
}
}
}
},
"incorporatedOn": {
"type": "string",
"example": "2018-02-28 00:00:00"
},
"registrationNumber": {
"type": "string",
"example": "1555555"
}
}
}
}
},
"lang": {
"type": "string",
"example": "en"
},
"type": {
"type": "string",
"example": "company"
},
"review": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"example": "2020-05-29T12:26:52.000+00:00"
},
"createDate": {
"type": "string",
"example": "2020-05-29T12:22:11.000+00:00"
},
"reviewDate": {
"type": "string",
"example": "2020-05-29T12:27:19.000+00:00"
},
"reprocessing": {
"type": "boolean",
"default": true,
"example": true
},
"reviewResult": {
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"example": "GREEN"
}
}
},
"reviewStatus": {
"type": "string",
"example": "completed"
},
"elapsedSinceQueuedMs": {
"type": "integer",
"default": 0,
"example": 26993
},
"elapsedSincePendingMs": {
"type": "integer",
"default": 0,
"example": 308656
}
}
},
"clientId": {
"type": "string",
"example": "coolclientid"
},
"createdAt": {
"type": "string",
"example": "2020-05-28 13:37:30"
},
"inspectionId": {
"type": "string",
"example": "5ecfbe9ad5ea48743f8dd1b9"
},
"externalUserId": {
"type": "string",
"example": "externalCompanyId"
},
"requiredIdDocs": {
"type": "object",
"properties": {
"docSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "company"
},
"idDocTypes": {
"type": "array",
"items": {
"type": "string",
"example": "COMPANY_DOC"
}
},
"minDocsCnt": {
"type": "integer",
"default": 0,
"example": 1
},
"idDocSubTypes": {}
}
}
},
"types": {
"type": "array",
"items": {
"type": "string",
"example": "COMPANY_DOC"
}
},
"idDocSetType": {
"type": "string",
"example": "COMPANY"
}
}
}
}
}
}
}
}
]
}
ApplicantGetDataResponse
{
"oneOf": [
{
"type": "object",
"title": "Individual applicants",
"properties": {
"id": {
"type": "string",
"example": "5b594ade0a975a36c9349e66"
},
"info": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"example": "1989-07-16"
},
"idDocs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"example": "1989-07-16"
},
"number": {
"type": "string",
"example": "LGXX359T8"
},
"country": {
"type": "string",
"example": "DEU"
},
"lastName": {
"type": "string",
"example": "SMITH"
},
"mrzLine1": {
"type": "string",
"example": "IDD<<LGXX359T88<<<<<<<<<<<<<<<"
},
"mrzLine2": {
"type": "string",
"example": "8907167<2809045D<<<<<<<<<<<<<8"
},
"mrzLine3": {
"type": "string",
"example": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<"
},
"firstName": {
"type": "string",
"example": "CHRISTIAN"
},
"idDocType": {
"type": "string",
"example": "ID_CARD"
},
"lastNameEn": {
"type": "string",
"example": "SMITH"
},
"validUntil": {
"type": "string",
"example": "2028-09-04"
},
"firstNameEn": {
"type": "string",
"example": "CHRISTIAN"
}
}
}
},
"country": {
"type": "string",
"example": "DEU"
},
"lastName": {
"type": "string",
"example": "SMITH"
},
"firstName": {
"type": "string",
"example": "CHRISTIAN"
},
"lastNameEn": {
"type": "string",
"example": "SMITH"
},
"firstNameEn": {
"type": "string",
"example": "CHRISTIAN"
}
}
},
"lang": {
"type": "string",
"example": "de"
},
"type": {
"type": "string",
"example": "individual"
},
"email": {
"type": "string",
"example": "christman1@gmail.com"
},
"review": {
"type": "object",
"properties": {
"levelName": {
"type": "string",
"example": "basic-kyc"
},
"createDate": {
"type": "string",
"example": "2020-06-24T05:11:02.000+00:00"
},
"reviewDate": {
"type": "string",
"example": "2020-06-24T05:12:58.000+00:00"
},
"reprocessing": {
"type": "boolean",
"default": true,
"example": true
},
"reviewResult": {
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"example": "GREEN"
}
}
},
"reviewStatus": {
"type": "string",
"example": "completed"
},
"elapsedSinceQueuedMs": {
"type": "integer",
"default": 0,
"example": 95785
},
"elapsedSincePendingMs": {
"type": "integer",
"default": 0,
"example": 115879
}
}
},
"clientId": {
"type": "string",
"example": "ClientName"
},
"agreement": {
"type": "object",
"properties": {
"source": {
"type": "string",
"example": "WebSDK"
},
"targets": {
"type": "array",
"items": {
"type": "string",
"example": "By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/)"
}
},
"createdAt": {
"type": "string",
"example": "2020-06-24 04:18:40"
}
}
},
"createdAt": {
"type": "string",
"example": "2020-06-24 05:05:14"
},
"fixedInfo": {
"type": "object",
"properties": {
"lastName": {
"type": "string",
"example": "Smith"
},
"firstName": {
"type": "string",
"example": "Chris"
}
}
},
"inspectionId": {
"type": "string",
"example": "5b594ade0a975a36c9379e67"
},
"externalUserId": {
"type": "string",
"example": "SomeExternalUserId"
},
"requiredIdDocs": {
"type": "object",
"properties": {
"docSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string",
"example": "PASSPORT"
}
},
"idDocSetType": {
"type": "string",
"example": "IDENTITY"
}
}
}
}
}
},
"applicantPlatform": {
"type": "string",
"example": "Android"
}
}
},
{
"type": "object",
"title": "Company applicants",
"properties": {
"id": {
"type": "string",
"example": "5ecfbe9ad5ea48743f8dd1b8"
},
"info": {
"type": "object",
"properties": {
"companyInfo": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "ltd"
},
"country": {
"type": "string",
"example": "GBR"
},
"website": {
"type": "string",
"example": "www.sumsub.com"
},
"companyName": {
"type": "string",
"example": "SUMSUB LIMITED"
},
"beneficiaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "ubo"
},
"imageIds": {},
"applicant": {},
"positions": {
"type": "array",
"items": {
"type": "string",
"example": "director"
}
},
"inRegistry": {
"type": "boolean",
"default": true,
"example": false
},
"applicantId": {
"type": "string",
"example": "5ecfbecad5ea48743f8dd438"
}
}
}
},
"incorporatedOn": {
"type": "string",
"example": "2018-02-28 00:00:00"
},
"registrationNumber": {
"type": "string",
"example": "1555555"
}
}
}
}
},
"lang": {
"type": "string",
"example": "en"
},
"type": {
"type": "string",
"example": "company"
},
"review": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"example": "2020-05-29T12:26:52.000+00:00"
},
"createDate": {
"type": "string",
"example": "2020-05-29T12:22:11.000+00:00"
},
"reviewDate": {
"type": "string",
"example": "2020-05-29T12:27:19.000+00:00"
},
"reprocessing": {
"type": "boolean",
"default": true,
"example": true
},
"reviewResult": {
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"example": "GREEN"
}
}
},
"reviewStatus": {
"type": "string",
"example": "completed"
},
"elapsedSinceQueuedMs": {
"type": "integer",
"default": 0,
"example": 26993
},
"elapsedSincePendingMs": {
"type": "integer",
"default": 0,
"example": 308656
}
}
},
"clientId": {
"type": "string",
"example": "coolclientid"
},
"createdAt": {
"type": "string",
"example": "2020-05-28 13:37:30"
},
"inspectionId": {
"type": "string",
"example": "5ecfbe9ad5ea48743f8dd1b9"
},
"externalUserId": {
"type": "string",
"example": "externalCompanyId"
},
"requiredIdDocs": {
"type": "object",
"properties": {
"docSets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "company"
},
"idDocTypes": {
"type": "array",
"items": {
"type": "string",
"example": "COMPANY_DOC"
}
},
"minDocsCnt": {
"type": "integer",
"default": 0,
"example": 1
},
"idDocSubTypes": {}
}
}
},
"types": {
"type": "array",
"items": {
"type": "string",
"example": "COMPANY_DOC"
}
},
"idDocSetType": {
"type": "string",
"example": "COMPANY"
}
}
}
}
}
}
}
}
]
}
ApplicantImportByArchiveRequest
{
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "An archive file."
}
}
}
ApplicantImportByArchiveRequest1
{
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "binary",
"description": "An archive file."
}
}
}
ApplicantImportCompletedRequest
{
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"tin": {
"type": "string",
"description": "Tax identification number."
},
"gender": {
"type": "string",
"description": "An applicant gender (`M` or `F`)."
},
"country": {
"type": "string",
"description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
}
},
"description": "List of applicant addresses."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"legalName": {
"type": "string",
"description": "Legal name."
},
"lastNameEn": {
"type": "string",
"description": "Automatic transliteration of the last name."
},
"middleName": {
"type": "string",
"description": "The middle name of the applicant."
},
"firstNameEn": {
"type": "string",
"description": "Automatic transliteration of the first name."
},
"nationality": {
"type": "string",
"description": "Alpha-3 country code."
},
"middleNameEn": {
"type": "string",
"description": "Automatic transliteration of the middle name."
},
"placeOfBirth": {
"type": "string",
"description": "The applicant birthplace."
},
"stateOfBirth": {
"type": "string",
"description": "Applicant state of birth."
},
"countryOfBirth": {
"type": "string",
"description": "Applicant country of birth."
}
},
"description": "Holds the personal applicant information extracted during verification."
},
"review": {
"type": "object",
"properties": {
"review": {
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"description": "\"GREEN\"/\"RED\""
},
"clientComment": {
"type": "string",
"description": "internal reason of rejection"
},
"reviewRejectType": {
"type": "string",
"description": "\"FINAL\"/\"RETRY\"(used only when \"reviewAnswer\"=\"RED\")"
},
"moderationComment": {
"type": "string",
"description": "Reason of rejection for end-user"
}
}
},
"createDate": {
"type": "string",
"description": "Date of users' creation on your side in a format: \"2022-11-21 08:25:32+0000\""
},
"reviewDate": {
"type": "string",
"description": "review date on your side in a format: \"2022-11-21 08:25:32+0000\""
},
"reviewStatus": {
"type": "string",
"description": "\"completed\""
}
},
"description": "Review results."
},
"externalUserId": {
"type": "string",
"description": "A unique applicant identifier as registered on your side."
}
}
}
ApplicantImportCompletedRequest1
{
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"tin": {
"type": "string",
"description": "Tax identification number."
},
"gender": {
"type": "string",
"description": "An applicant gender (`M` or `F`)."
},
"country": {
"type": "string",
"description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
}
},
"description": "List of applicant addresses."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"legalName": {
"type": "string",
"description": "Legal name."
},
"lastNameEn": {
"type": "string",
"description": "Automatic transliteration of the last name."
},
"middleName": {
"type": "string",
"description": "The middle name of the applicant."
},
"firstNameEn": {
"type": "string",
"description": "Automatic transliteration of the first name."
},
"nationality": {
"type": "string",
"description": "Alpha-3 country code."
},
"middleNameEn": {
"type": "string",
"description": "Automatic transliteration of the middle name."
},
"placeOfBirth": {
"type": "string",
"description": "The applicant birthplace."
},
"stateOfBirth": {
"type": "string",
"description": "Applicant state of birth."
},
"countryOfBirth": {
"type": "string",
"description": "Applicant country of birth."
}
},
"description": "Holds the personal applicant information extracted during verification."
},
"review": {
"type": "object",
"properties": {
"review": {
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"description": "\"GREEN\"/\"RED\""
},
"clientComment": {
"type": "string",
"description": "internal reason of rejection"
},
"reviewRejectType": {
"type": "string",
"description": "\"FINAL\"/\"RETRY\"(used only when \"reviewAnswer\"=\"RED\")"
},
"moderationComment": {
"type": "string",
"description": "Reason of rejection for end-user"
}
}
},
"createDate": {
"type": "string",
"description": "Date of users' creation on your side in a format: \"2022-11-21 08:25:32+0000\""
},
"reviewDate": {
"type": "string",
"description": "review date on your side in a format: \"2022-11-21 08:25:32+0000\""
},
"reviewStatus": {
"type": "string",
"description": "\"completed\""
}
},
"description": "Review results."
},
"externalUserId": {
"type": "string",
"description": "A unique applicant identifier as registered on your side."
}
}
}
ApplicantMoveTransactionToAnotherApplicantResponse
{
"type": "object",
"properties": {}
}
ApplicantRemoveCustomTagsRequest
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
ApplicantRemoveCustomTagsRequest1
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
ApplicantSandboxVerificationResponseRequest
{
"type": "object",
"required": [
"reviewAnswer",
"rejectLabels"
],
"properties": {
"rejectLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of [rejection labels](/docs/receive-and-interpret-results-via-api#understand-rejection)."
},
"reviewAnswer": {
"type": "string",
"description": "A `GREEN` or `RED` label under which you want to simulate the response. For more information, see [this article](https://docs.sumsub.com/reference)."
},
"clientComment": {
"type": "string",
"description": "A rejection comment that should not be available to your applicants."
},
"reviewRejectType": {
"type": "string",
"description": "A `FINAL` or `RETRY` rejection type indicating whether a rejection should be final or temporary."
},
"moderationComment": {
"type": "string",
"description": "A comment that supposed to be shown to the applicant, explaining the reason of rejection."
}
}
}
ApplicantSandboxVerificationResponseRequest1
{
"type": "object",
"required": [
"reviewAnswer",
"rejectLabels"
],
"properties": {
"rejectLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of [rejection labels](/docs/receive-and-interpret-results-via-api#understand-rejection)."
},
"reviewAnswer": {
"type": "string",
"description": "A `GREEN` or `RED` label under which you want to simulate the response. For more information, see [this article](https://docs.sumsub.com/reference)."
},
"clientComment": {
"type": "string",
"description": "A rejection comment that should not be available to your applicants."
},
"reviewRejectType": {
"type": "string",
"description": "A `FINAL` or `RETRY` rejection type indicating whether a rejection should be final or temporary."
},
"moderationComment": {
"type": "string",
"description": "A comment that supposed to be shown to the applicant, explaining the reason of rejection."
}
}
}
ApplicantSubmitTransactionDataRequest
{
"type": "object",
"required": [
"txnId",
"info",
"applicant",
"counterparty"
],
"properties": {
"info": {
"type": "object",
"required": [
"direction",
"amount",
"currencyCode"
],
"properties": {
"type": {
"type": "string",
"description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction."
},
"direction": {
"type": "string",
"description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
},
"cryptoParams": {
"type": "object",
"required": [
"attemptId"
],
"properties": {
"attemptId": {
"type": "string",
"description": "Unique identifier of the transaction attempt."
},
"cryptoChain": {
"type": "string",
"description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
},
"outputIndex": {
"type": "integer",
"format": "int32",
"description": "An index number for a transaction output."
}
},
"description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
},
"currencyCode": {
"type": "string",
"description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
},
"currencyType": {
"type": "string",
"description": "Indicates whether the transaction is `crypto` or `fiat`."
},
"paymentTxnId": {
"type": "string",
"description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
},
"paymentDetails": {
"type": "string",
"description": "A comment with payment details."
},
"amountInDefaultCurrency": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
}
},
"description": "An object representing transaction information."
},
"type": {
"type": "string",
"default": "finance",
"description": "A transaction type. Expects values: </br> <ul> <li><code>finance</code>(default)</li> <li><code>gamblingBet</code></li> <li><code>gamblingLimitChange</code></li> <li><code>gamblingBonusChange</code></li> <li><code>kyc</code></li> <li><code>travelRule</code></li> <li><code>userPlatformEvent</code></li> <ul> <li><code>login</code></li> <li><code>signup</code></li> <li><code>passwordChange</code></li> <li><code>twoFaReset</code></li> </ul> </ul>"
},
"props": {
"type": "object",
"properties": {
"customTxnLimit": {
"type": "string",
"default": "1000"
}
},
"description": "A map of strings in JSON format with custom keys and string values. Represents transaction properties."
},
"txnId": {
"type": "string",
"description": "A unique transaction identification number. <br>**Note:** If the specified `txnId` already exists, a `409` error code \"Entity already exists\" is returned. To update an existing transaction, use the [bulk import method](doc:update-transactions-via-bulk-import-method)."
},
"txnDate": {
"type": "string",
"format": "date",
"description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
},
"applicant": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
},
"sourceKey": {
"type": "string",
"description": "A source key indication to separate access to transactions."
},
"counterparty": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
}
}
}
ApplicantSubmitTransactionDataRequest1
{
"type": "object",
"required": [
"txnId",
"info",
"applicant",
"counterparty"
],
"properties": {
"info": {
"type": "object",
"required": [
"direction",
"amount",
"currencyCode"
],
"properties": {
"type": {
"type": "string",
"description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction."
},
"direction": {
"type": "string",
"description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
},
"cryptoParams": {
"type": "object",
"required": [
"attemptId"
],
"properties": {
"attemptId": {
"type": "string",
"description": "Unique identifier of the transaction attempt."
},
"cryptoChain": {
"type": "string",
"description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
},
"outputIndex": {
"type": "integer",
"format": "int32",
"description": "An index number for a transaction output."
}
},
"description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
},
"currencyCode": {
"type": "string",
"description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
},
"currencyType": {
"type": "string",
"description": "Indicates whether the transaction is `crypto` or `fiat`."
},
"paymentTxnId": {
"type": "string",
"description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
},
"paymentDetails": {
"type": "string",
"description": "A comment with payment details."
},
"amountInDefaultCurrency": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
}
},
"description": "An object representing transaction information."
},
"type": {
"type": "string",
"default": "finance",
"description": "A transaction type. Expects values: </br> <ul> <li><code>finance</code>(default)</li> <li><code>gamblingBet</code></li> <li><code>gamblingLimitChange</code></li> <li><code>gamblingBonusChange</code></li> <li><code>kyc</code></li> <li><code>travelRule</code></li> <li><code>userPlatformEvent</code></li> <ul> <li><code>login</code></li> <li><code>signup</code></li> <li><code>passwordChange</code></li> <li><code>twoFaReset</code></li> </ul> </ul>"
},
"props": {
"type": "object",
"properties": {
"customTxnLimit": {
"type": "string",
"default": "1000"
}
},
"description": "A map of strings in JSON format with custom keys and string values. Represents transaction properties."
},
"txnId": {
"type": "string",
"description": "A unique transaction identification number. <br>**Note:** If the specified `txnId` already exists, a `409` error code \"Entity already exists\" is returned. To update an existing transaction, use the [bulk import method](doc:update-transactions-via-bulk-import-method)."
},
"txnDate": {
"type": "string",
"format": "date",
"description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
},
"applicant": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
},
"sourceKey": {
"type": "string",
"description": "A source key indication to separate access to transactions."
},
"counterparty": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
}
}
}
ApplicantSubmitTransactionForNonExistingRequest
{
"type": "object",
"required": [
"txnId",
"info",
"applicant",
"counterparty"
],
"properties": {
"info": {
"type": "object",
"required": [
"direction",
"amount",
"currencyCode"
],
"properties": {
"type": {
"type": "string",
"description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction."
},
"direction": {
"type": "string",
"description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
},
"cryptoParams": {
"type": "object",
"required": [
"attemptId"
],
"properties": {
"attemptId": {
"type": "string",
"description": "Unique identifier of the transaction attempt."
},
"cryptoChain": {
"type": "string",
"description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
},
"outputIndex": {
"type": "integer",
"format": "int32",
"description": "An index number for a transaction output."
}
},
"description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
},
"currencyCode": {
"type": "string",
"description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
},
"currencyType": {
"type": "string",
"description": "Indicates whether the transaction is `crypto` or `fiat`."
},
"paymentTxnId": {
"type": "string",
"description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
},
"paymentDetails": {
"type": "string",
"description": "A comment with payment details."
},
"amountInDefaultCurrency": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
}
},
"description": "An object representing transaction information."
},
"type": {
"type": "string",
"default": "finance",
"description": "A transaction type. Expects values: </br> <ul> <li><code>finance</code>(default)</li> <li><code>gamblingBet</code></li> <li><code>gamblingLimitChange</code></li> <li><code>gamblingBonusChange</code></li> <li><code>kyc</code></li> <li><code>travelRule</code></li> <li><code>userPlatformEvent</code></li> <ul> <li><code>login</code></li> <li><code>signup</code></li> <li><code>passwordChange</code></li> <li><code>twoFaReset</code></li> </ul> </ul>"
},
"props": {
"type": "object",
"properties": {},
"description": "Transaction properties. Map of strings (JSON) of custom keys and string values."
},
"txnId": {
"type": "string",
"description": "A unique transaction identification number."
},
"txnDate": {
"type": "string",
"format": "date",
"description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
},
"applicant": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
},
"sourceKey": {
"type": "string",
"description": "A source key indication to separate access to transactions."
},
"counterparty": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
}
}
}
ApplicantSubmitTransactionForNonExistingRequest1
{
"type": "object",
"required": [
"txnId",
"info",
"applicant",
"counterparty"
],
"properties": {
"info": {
"type": "object",
"required": [
"direction",
"amount",
"currencyCode"
],
"properties": {
"type": {
"type": "string",
"description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction."
},
"direction": {
"type": "string",
"description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
},
"cryptoParams": {
"type": "object",
"required": [
"attemptId"
],
"properties": {
"attemptId": {
"type": "string",
"description": "Unique identifier of the transaction attempt."
},
"cryptoChain": {
"type": "string",
"description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
},
"outputIndex": {
"type": "integer",
"format": "int32",
"description": "An index number for a transaction output."
}
},
"description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
},
"currencyCode": {
"type": "string",
"description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
},
"currencyType": {
"type": "string",
"description": "Indicates whether the transaction is `crypto` or `fiat`."
},
"paymentTxnId": {
"type": "string",
"description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
},
"paymentDetails": {
"type": "string",
"description": "A comment with payment details."
},
"amountInDefaultCurrency": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
}
},
"description": "An object representing transaction information."
},
"type": {
"type": "string",
"default": "finance",
"description": "A transaction type. Expects values: </br> <ul> <li><code>finance</code>(default)</li> <li><code>gamblingBet</code></li> <li><code>gamblingLimitChange</code></li> <li><code>gamblingBonusChange</code></li> <li><code>kyc</code></li> <li><code>travelRule</code></li> <li><code>userPlatformEvent</code></li> <ul> <li><code>login</code></li> <li><code>signup</code></li> <li><code>passwordChange</code></li> <li><code>twoFaReset</code></li> </ul> </ul>"
},
"props": {
"type": "object",
"properties": {},
"description": "Transaction properties. Map of strings (JSON) of custom keys and string values."
},
"txnId": {
"type": "string",
"description": "A unique transaction identification number."
},
"txnDate": {
"type": "string",
"format": "date",
"description": "Date and time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
},
"applicant": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data with mandatory `applicantId` (sender or remitter, depending on `info.direction`)."
},
"sourceKey": {
"type": "string",
"description": "A source key indication to separate access to transactions."
},
"counterparty": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data (sender or remitter, depending on `info.direction`)."
}
}
}
ApplicantUpdateFixedInfoRequest
{
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"tin": {
"type": "string",
"description": "Tax identification number."
},
"gender": {
"type": "string",
"description": "An applicant gender (`M` or `F`)."
},
"country": {
"type": "string",
"description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"addresses": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "List of applicant addresses."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"legalName": {
"type": "string",
"description": "Legal name."
},
"lastNameEn": {
"type": "string",
"description": "Automatic transliteration of the last name."
},
"middleName": {
"type": "string",
"description": "The middle name of the applicant."
},
"firstNameEn": {
"type": "string",
"description": "Automatic transliteration of the first name."
},
"nationality": {
"type": "string",
"description": "Alpha-3 country code."
},
"middleNameEn": {
"type": "string",
"description": "Automatic transliteration of the middle name."
},
"placeOfBirth": {
"type": "string",
"description": "The applicant birthplace."
},
"stateOfBirth": {
"type": "string",
"description": "Applicant state of birth."
},
"countryOfBirth": {
"type": "string",
"description": "Applicant country of birth."
}
}
}
ApplicantUpdateFixedInfoRequest1
{
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant date of birth (format `YYYY-mm-dd`, e.g. 2001-09-25)."
},
"tin": {
"type": "string",
"description": "Tax identification number."
},
"gender": {
"type": "string",
"description": "An applicant gender (`M` or `F`)."
},
"country": {
"type": "string",
"description": "Alpha-3 country code (e.g. `DEU` or `GBR`)."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"addresses": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "List of applicant addresses."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"legalName": {
"type": "string",
"description": "Legal name."
},
"lastNameEn": {
"type": "string",
"description": "Automatic transliteration of the last name."
},
"middleName": {
"type": "string",
"description": "The middle name of the applicant."
},
"firstNameEn": {
"type": "string",
"description": "Automatic transliteration of the first name."
},
"nationality": {
"type": "string",
"description": "Alpha-3 country code."
},
"middleNameEn": {
"type": "string",
"description": "Automatic transliteration of the middle name."
},
"placeOfBirth": {
"type": "string",
"description": "The applicant birthplace."
},
"stateOfBirth": {
"type": "string",
"description": "Applicant state of birth."
},
"countryOfBirth": {
"type": "string",
"description": "Applicant country of birth."
}
}
}
ApplicantUpdateTopLevelInfoRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "A unique applicant identifier."
},
"lang": {
"type": "string",
"description": "The language, in which the applicant should see the verification results."
},
"email": {
"type": "string",
"description": "A new email address that you want to assign to the given applicant."
},
"phone": {
"type": "string",
"description": "A new phone number that you want to assign to the given applicant."
},
"deleted": {
"type": "boolean",
"description": "Marks the applicant profile as inactive."
},
"metadata": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "Additional information about the applicant."
},
"sourceKey": {
"type": "string",
"description": "A new [source key](https://docs.sumsub.com/reference) that you want to assign to the given applicant."
},
"externalUserId": {
"type": "string",
"description": "An external applicant identifier."
},
"questionnaires": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "A [questionnaire](https://docs.sumsub.com/reference) configuration with the answers."
}
}
}
ApplicantUpdateTopLevelInfoRequest1
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "A unique applicant identifier."
},
"lang": {
"type": "string",
"description": "The language, in which the applicant should see the verification results."
},
"email": {
"type": "string",
"description": "A new email address that you want to assign to the given applicant."
},
"phone": {
"type": "string",
"description": "A new phone number that you want to assign to the given applicant."
},
"deleted": {
"type": "boolean",
"description": "Marks the applicant profile as inactive."
},
"metadata": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "Additional information about the applicant."
},
"sourceKey": {
"type": "string",
"description": "A new [source key](https://docs.sumsub.com/reference) that you want to assign to the given applicant."
},
"externalUserId": {
"type": "string",
"description": "An external applicant identifier."
},
"questionnaires": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "A [questionnaire](https://docs.sumsub.com/reference) configuration with the answers."
}
}
}
NoteAddToTransactionRequest
{
"type": "object",
"required": [
"txnId",
"note"
],
"properties": {
"note": {
"type": "string",
"description": "A note to add."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "[Tags](https://docs.sumsub.com/reference) that you may want to assign."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
}
}
}
NoteAddToTransactionRequest1
{
"type": "object",
"required": [
"txnId",
"note"
],
"properties": {
"note": {
"type": "string",
"description": "A note to add."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "[Tags](https://docs.sumsub.com/reference) that you may want to assign."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
}
}
}
NoteRemoveFromTransactionRequest
{
"type": "object",
"required": [
"txnId",
"id"
],
"properties": {
"id": {
"type": "string",
"description": "A unique note identifier."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
}
}
}
NoteRemoveFromTransactionRequest1
{
"type": "object",
"required": [
"txnId",
"id"
],
"properties": {
"id": {
"type": "string",
"description": "A unique note identifier."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
}
}
}
NoteUpdateTransactionNotesRequest
{
"type": "object",
"required": [
"txnId",
"id",
"note"
],
"properties": {
"id": {
"type": "string",
"description": "A unique note identifier."
},
"note": {
"type": "string",
"description": "A new note."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "[Tags](https://docs.sumsub.com/reference) that you may want to assign."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
}
}
}
NoteUpdateTransactionNotesRequest1
{
"type": "object",
"required": [
"txnId",
"id",
"note"
],
"properties": {
"id": {
"type": "string",
"description": "A unique note identifier."
},
"note": {
"type": "string",
"description": "A new note."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "[Tags](https://docs.sumsub.com/reference) that you may want to assign."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
}
}
}
TagAddTransactionTagsRequest
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to add. Case-sensitive."
}
}
}
TagAddTransactionTagsRequest1
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to add. Case-sensitive."
}
}
}
TransactionApproveRejectRequest
{
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"description": "Sets the review answer. Can be `GREEN` or `RED`."
}
}
}
TransactionApproveRejectRequest1
{
"type": "object",
"properties": {
"reviewAnswer": {
"type": "string",
"description": "Sets the review answer. Can be `GREEN` or `RED`."
}
}
}
TransactionBulkImportRequest
{
"type": "object",
"required": [
"applicantId",
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"txnId"
],
"properties": {
"info": {
"type": "object",
"required": [
"direction",
"amount",
"currencyCode"
],
"properties": {
"type": {
"type": "string",
"description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction."
},
"direction": {
"type": "string",
"description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
},
"cryptoParams": {
"type": "object",
"required": [
"attemptId"
],
"properties": {
"attemptId": {
"type": "string",
"description": "Unique identifier of the transaction attempt."
},
"cryptoChain": {
"type": "string",
"description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
},
"outputIndex": {
"type": "integer",
"format": "int32",
"description": "An index number for a transaction output."
}
},
"description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
},
"currencyCode": {
"type": "string",
"description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
},
"currencyType": {
"type": "string",
"description": "Indicates whether the transaction is `crypto` or `fiat`."
},
"paymentTxnId": {
"type": "string",
"description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
},
"paymentDetails": {
"type": "string",
"description": "A comment with payment details."
},
"amountInDefaultCurrency": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
}
},
"description": "Transaction information."
},
"type": {
"type": "string",
"description": "Transaction type. Takes predefined values: `finance`/`gamblingBet`/`gamblingLimitChange`/`kyc`/`login`/`signup`/`passwordChange`/`twoFaReset`/`travelRule` (`finance` by default)."
},
"props": {
"type": "string",
"description": "Transaction properties. Map of strings - JSON of custom keys and string values."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
},
"txnDate": {
"type": "string",
"format": "date",
"description": "Time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
},
"applicant": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data with mandatory `applicantId` (sender or remitter depending on `info.direction`)."
},
"sourceKey": {
"type": "string",
"description": "Source Key indication to separate accesses to transactions."
},
"counterparty": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data (sender or remitter depending on `info.direction`)."
}
},
"description": "An object representing the transaction. For more information on the structure, see [Submit transaction for existing applicant](ref:submit-transaction-for-existing-applicant)."
},
"applicantId": {
"type": "string",
"description": "A unique identification number of the applicant who passed user verification (KYC)."
}
}
}
TransactionBulkImportRequest1
{
"type": "object",
"required": [
"applicantId",
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"txnId"
],
"properties": {
"info": {
"type": "object",
"required": [
"direction",
"amount",
"currencyCode"
],
"properties": {
"type": {
"type": "string",
"description": "Accepts any value that helps you categorize transactions. For example, for gambling transactions, you can specify `bonus`, `payroll`, or `cashback`."
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction."
},
"direction": {
"type": "string",
"description": "Can be `out` (applicant sends to counterparty) or `in` (counterparty sends to applicant)."
},
"cryptoParams": {
"type": "object",
"required": [
"attemptId"
],
"properties": {
"attemptId": {
"type": "string",
"description": "Unique identifier of the transaction attempt."
},
"cryptoChain": {
"type": "string",
"description": "The crypto chain name. Mandatory for crypto tokens only. Specifies the network name to which the token at `currencyCode` belongs. Empty for native tokens (e.g. for `BTC`, `ETH`). For more information, see [chain codes](ref:crypto-chain-codes)."
},
"outputIndex": {
"type": "integer",
"format": "int32",
"description": "An index number for a transaction output."
}
},
"description": "Includes crypto transaction parameters. It is crucial for Sumsub to understand which crypto chain is used to correctly utilize the data."
},
"currencyCode": {
"type": "string",
"description": "Currency code (`USD`, `GBP`, `BTC`, etc)."
},
"currencyType": {
"type": "string",
"description": "Indicates whether the transaction is `crypto` or `fiat`."
},
"paymentTxnId": {
"type": "string",
"description": "Crypto transaction ID from the blockchain. Required for crypto check requests only."
},
"paymentDetails": {
"type": "string",
"description": "A comment with payment details."
},
"amountInDefaultCurrency": {
"type": "number",
"format": "double",
"description": "The amount of funds used in this transaction in the default currency. For more precise calculations, you can submit already converted default currency amount in this field."
}
},
"description": "Transaction information."
},
"type": {
"type": "string",
"description": "Transaction type. Takes predefined values: `finance`/`gamblingBet`/`gamblingLimitChange`/`kyc`/`login`/`signup`/`passwordChange`/`twoFaReset`/`travelRule` (`finance` by default)."
},
"props": {
"type": "string",
"description": "Transaction properties. Map of strings - JSON of custom keys and string values."
},
"txnId": {
"type": "string",
"description": "A unique transaction identifier."
},
"txnDate": {
"type": "string",
"format": "date",
"description": "Time when the transaction was initiated (format `yyyy-MM-dd HH:mm:ss+XXXX`, e.g. 2022-11-24 23:37:02+0000)."
},
"applicant": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data with mandatory `applicantId` (sender or remitter depending on `info.direction`)."
},
"sourceKey": {
"type": "string",
"description": "Source Key indication to separate accesses to transactions."
},
"counterparty": {
"type": "object",
"required": [
"externalUserId",
"fullName",
"type"
],
"properties": {
"type": {
"type": "string",
"default": "individual",
"description": "Participant entity type: `company` or `individual`. Set to `individual` by default."
},
"device": {
"type": "object",
"properties": {
"coords": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"accuracy": {
"type": "string",
"description": "Accuracy of the latitude and longitude properties, expressed in meters. #"
}
},
"description": "Coordinates."
},
"ipInfo": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "IP address."
},
"asn": {
"type": "integer",
"format": "int32",
"description": "ASN."
},
"lat": {
"type": "number",
"format": "double",
"description": "Position latitude in decimal degrees."
},
"lon": {
"type": "number",
"format": "double",
"description": "Position longitude in decimal degrees."
},
"asnOrg": {
"type": "string",
"description": "ASN organisation."
},
"riskyAsn": {
"type": "boolean",
"description": "ASN is risky or not."
},
"countryCode3": {
"type": "string",
"description": "Country Alpha-3 code."
}
},
"description": "Data about used IP address."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Device address."
},
"platform": {
"type": "string",
"description": "Device platform, e.g. `Mobile Android`."
},
"sessionId": {
"type": "string",
"description": "Transaction session identifier."
},
"userAgent": {
"type": "string",
"description": "Device user agent."
},
"acceptLang": {
"type": "string",
"description": "From browser, e.g. `en`."
},
"fingerprint": {
"type": "string",
"description": "Device fingerprint."
},
"sessionAgeMs": {
"type": "integer",
"format": "int64",
"description": "Session lifetime in milliseconds."
}
},
"description": "Device information."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Participant address."
},
"fullName": {
"type": "string",
"description": "Full name of the participant."
},
"paymentMethod": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Payment method type: `card`/`account`/`crypto`."
},
"2faUsed": {
"type": "boolean",
"description": "Indication of 2fa being used."
},
"3dsUsed": {
"type": "boolean",
"description": "Indication of 3d secure auth being used."
},
"accountId": {
"type": "string",
"description": "Representation of the account ID: Account number, IBAN or DC hash for `card`, crypto wallet address for `crypto` type etc."
},
"issuingCountry": {
"type": "string",
"description": "The payment issuing country code in Alpha-3 format."
}
},
"description": "Information about the payment method."
},
"externalUserId": {
"type": "string",
"description": "An external identifier of the transaction participant (applicant or counterparty). Each participant must have a unique identifier that must be reused during all subsequent transactions. Make sure to use the same `externalUserID` for the same counterparty or applicant."
},
"institutionInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Transaction institution code."
},
"name": {
"type": "string",
"description": "Transaction institution name."
},
"address": {
"type": "object",
"properties": {
"town": {
"type": "string",
"description": "Town or city name."
},
"state": {
"type": "string",
"description": "State name (if applicable)."
},
"street": {
"type": "string",
"description": "Street name."
},
"country": {
"type": "string",
"description": "Alpha-3 country code."
},
"postCode": {
"type": "string",
"description": "Postal code."
},
"subStreet": {
"type": "string",
"description": "Additional street information."
},
"flatNumber": {
"type": "string",
"description": "Flat or apartment number."
},
"buildingName": {
"type": "string",
"description": "Building name (if applicable)."
},
"buildingNumber": {
"type": "string",
"description": "Building number."
}
},
"description": "Transaction institution address."
},
"internalId": {
"type": "string",
"description": "VASP ID for counterparty transaction. If provided, we trust the exchange and use the expected VASP for transaction approval."
}
},
"description": "Transaction institution information"
}
},
"description": "Transaction participant data (sender or remitter depending on `info.direction`)."
}
},
"description": "An object representing the transaction. For more information on the structure, see [Submit transaction for existing applicant](ref:submit-transaction-for-existing-applicant)."
},
"applicantId": {
"type": "string",
"description": "A unique identification number of the applicant who passed user verification (KYC)."
}
}
}
TransactionRemoveTagsRequest
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to remove. Case-sensitive."
}
}
}
TransactionRemoveTagsRequest1
{
"type": "object",
"properties": {
"RAW_BODY": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to remove. Case-sensitive."
}
}
}
TransactionUpdateBlockchainInfoRequest
{
"type": "object",
"properties": {
"fingerprint": {
"type": "string",
"description": "A crypto transaction ID received from the blockchain."
}
}
}
TransactionUpdateBlockchainInfoRequest1
{
"type": "object",
"properties": {
"fingerprint": {
"type": "string",
"description": "A crypto transaction ID received from the blockchain."
}
}
}
TransactionUpdateBlockchainInfoResponse
{
"type": "object",
"properties": {}
}
TransactionUpdatePropertiesRequest
{
"type": "object",
"required": [
"customProperty"
],
"properties": {
"customProperty": {
"type": "string",
"default": "newValue"
}
}
}
TransactionUpdatePropertiesRequest1
{
"type": "object",
"required": [
"customProperty"
],
"properties": {
"customProperty": {
"type": "string",
"default": "newValue"
}
}
}
VaspGetAvailableVasps400Response
{
"type": "object",
"properties": {}
}
VaspGetAvailableVaspsResponse
{
"type": "object",
"properties": {}
}
VerificationSubmitApplicantDataRequest
{
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"tin": {
"type": "string",
"description": "Tax identifier."
},
"country": {
"enum": [
"ARG",
"BGD",
"BRA",
"GBR",
"IDN",
"IND",
"KEN",
"MEX",
"NGA",
"NLD",
"VNM",
"ZAF"
],
"type": "string",
"description": "Alpha-3 country code."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
}
},
"description": "Information about the applicant."
},
"idDoc": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant's date of birth."
},
"gender": {
"type": "string",
"description": "Applicant's gender."
},
"number": {
"type": "string",
"description": "Document number."
},
"country": {
"enum": [
"ARG",
"BGD",
"BRA",
"GBR",
"IDN",
"IND",
"KEN",
"MEX",
"NGA",
"NLD",
"VNM",
"ZAF"
],
"type": "string",
"description": "Alpha-3 country code."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"idDocType": {
"type": "string",
"description": "Document type."
}
},
"description": "Information about the document."
}
}
}
VerificationSubmitApplicantDataRequest1
{
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"tin": {
"type": "string",
"description": "Tax identifier."
},
"country": {
"enum": [
"ARG",
"BGD",
"BRA",
"GBR",
"IDN",
"IND",
"KEN",
"MEX",
"NGA",
"NLD",
"VNM",
"ZAF"
],
"type": "string",
"description": "Alpha-3 country code."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
}
},
"description": "Information about the applicant."
},
"idDoc": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"description": "Applicant's date of birth."
},
"gender": {
"type": "string",
"description": "Applicant's gender."
},
"number": {
"type": "string",
"description": "Document number."
},
"country": {
"enum": [
"ARG",
"BGD",
"BRA",
"GBR",
"IDN",
"IND",
"KEN",
"MEX",
"NGA",
"NLD",
"VNM",
"ZAF"
],
"type": "string",
"description": "Alpha-3 country code."
},
"lastName": {
"type": "string",
"description": "The last name of the applicant."
},
"firstName": {
"type": "string",
"description": "The first name of the applicant."
},
"idDocType": {
"type": "string",
"description": "Document type."
}
},
"description": "Information about the document."
}
}
}