Initiate Remote Scan

Initiate remote scan based on the specified request parameters.

POST /v1/Scanners/InitiateRemoteScan

Request body

Code sample language

curl -X POST "{{API.SANDBOX_BASE_URL}}/Scanners/InitiateRemoteScan" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "traceId": "string",
  "deviceId": "string",
  "scannerTriggerMode": "Manual",
  "imagesToCapture": {
    "documentWhiteLight": {
      "isEnabled": true
    },
    "documentInfraredLight": {
      "isEnabled": true
    },
    "documentUltravioletLight": {
      "isEnabled": true
    },
    "documentHolograms": {
      "isEnabled": true
    },
    "documentLightPassThrough": {
      "isEnabled": true
    },
    "selfieImage": {
      "isEnabled": true
    }
  },
  "processDocumentInputParams": {
    "dateFormat": "yyyy-MM-dd",
    "returnFieldsAoi": true,
    "returnFieldValidations": true,
    "returnFieldLabels": true,
    "returnCalculatedFields": true,
    "returnFrontImage": true,
    "returnBackImage": true,
    "returnFaceImage": true,
    "returnSignatureImage": true,
    "returnGhostFaceImage": true,
    "returnFaceImageLocation": true,
    "returnFrontImageLocation": true,
    "returnGhostFaceImageLocation": false,
    "returnSignatureLocation": false,
    "fetchWebFields": false,
    "returnDocumentForensicAuthentications": false,
    "shouldFailExpiredDocuments": true,
    "returnMatchBetweenPortraitAndGhost": false,
    "checkForSelfieLiveness": false,
    "performAddressValidation": false,
    "performPostalCodeValidation": false,
    "performIdentityVerification": false,
    "performAAMVADriverLicenseVerification": false,
    "performAgeVerification": false,
    "performKnowledgeBasedAuthentication": false,
    "performFullNameBreakdown": false,
    "ageLimit": 0,
    "checkForDocumentLiveness": false,
    "shouldHandleEmbeddedChip": false,
    "portraitReplacementThresholdScore": 0,
    "screenCaptureThresholdScore": 0,
    "paperPhotocopyThresholdScore": 0
  }
}'

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var content = new StringContent(@"{
  ""traceId"": ""string"",
  ""deviceId"": ""string"",
  ""scannerTriggerMode"": ""Manual"",
  ""imagesToCapture"": {
    ""documentWhiteLight"": {
      ""isEnabled"": true
    },
    ""documentInfraredLight"": {
      ""isEnabled"": true
    },
    ""documentUltravioletLight"": {
      ""isEnabled"": true
    },
    ""documentHolograms"": {
      ""isEnabled"": true
    },
    ""documentLightPassThrough"": {
      ""isEnabled"": true
    },
    ""selfieImage"": {
      ""isEnabled"": true
    }
  },
  ""processDocumentInputParams"": {
    ""dateFormat"": ""yyyy-MM-dd"",
    ""returnFieldsAoi"": true,
    ""returnFieldValidations"": true,
    ""returnFieldLabels"": true,
    ""returnCalculatedFields"": true,
    ""returnFrontImage"": true,
    ""returnBackImage"": true,
    ""returnFaceImage"": true,
    ""returnSignatureImage"": true,
    ""returnGhostFaceImage"": true,
    ""returnFaceImageLocation"": true,
    ""returnFrontImageLocation"": true,
    ""returnGhostFaceImageLocation"": false,
    ""returnSignatureLocation"": false,
    ""fetchWebFields"": false,
    ""returnDocumentForensicAuthentications"": false,
    ""shouldFailExpiredDocuments"": true,
    ""returnMatchBetweenPortraitAndGhost"": false,
    ""checkForSelfieLiveness"": false,
    ""performAddressValidation"": false,
    ""performPostalCodeValidation"": false,
    ""performIdentityVerification"": false,
    ""performAAMVADriverLicenseVerification"": false,
    ""performAgeVerification"": false,
    ""performKnowledgeBasedAuthentication"": false,
    ""performFullNameBreakdown"": false,
    ""ageLimit"": 0,
    ""checkForDocumentLiveness"": false,
    ""shouldHandleEmbeddedChip"": false,
    ""portraitReplacementThresholdScore"": 0,
    ""screenCaptureThresholdScore"": 0,
    ""paperPhotocopyThresholdScore"": 0
  }
}", System.Text.Encoding.UTF8, "application/json");
var response = await client.PostAsync("{{API.SANDBOX_BASE_URL}}/Scanners/InitiateRemoteScan", content);
var result = await response.Content.ReadAsStringAsync();

import requests

headers = {"x-api-key": "YOUR_API_KEY"}
payload = {
  "traceId": "string",
  "deviceId": "string",
  "scannerTriggerMode": "Manual",
  "imagesToCapture": {
    "documentWhiteLight": {
      "isEnabled": True
    },
    "documentInfraredLight": {
      "isEnabled": True
    },
    "documentUltravioletLight": {
      "isEnabled": True
    },
    "documentHolograms": {
      "isEnabled": True
    },
    "documentLightPassThrough": {
      "isEnabled": True
    },
    "selfieImage": {
      "isEnabled": True
    }
  },
  "processDocumentInputParams": {
    "dateFormat": "yyyy-MM-dd",
    "returnFieldsAoi": True,
    "returnFieldValidations": True,
    "returnFieldLabels": True,
    "returnCalculatedFields": True,
    "returnFrontImage": True,
    "returnBackImage": True,
    "returnFaceImage": True,
    "returnSignatureImage": True,
    "returnGhostFaceImage": True,
    "returnFaceImageLocation": True,
    "returnFrontImageLocation": True,
    "returnGhostFaceImageLocation": False,
    "returnSignatureLocation": False,
    "fetchWebFields": False,
    "returnDocumentForensicAuthentications": False,
    "shouldFailExpiredDocuments": True,
    "returnMatchBetweenPortraitAndGhost": False,
    "checkForSelfieLiveness": False,
    "performAddressValidation": False,
    "performPostalCodeValidation": False,
    "performIdentityVerification": False,
    "performAAMVADriverLicenseVerification": False,
    "performAgeVerification": False,
    "performKnowledgeBasedAuthentication": False,
    "performFullNameBreakdown": False,
    "ageLimit": 0,
    "checkForDocumentLiveness": False,
    "shouldHandleEmbeddedChip": False,
    "portraitReplacementThresholdScore": 0,
    "screenCaptureThresholdScore": 0,
    "paperPhotocopyThresholdScore": 0
  }
}
response = requests.post("{{API.SANDBOX_BASE_URL}}/Scanners/InitiateRemoteScan", headers=headers, json=payload)
print(response.json())

const response = await fetch("{{API.SANDBOX_BASE_URL}}/Scanners/InitiateRemoteScan", {
  method: "POST",
  headers: { "x-api-key": "YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "traceId": "string",
    "deviceId": "string",
    "scannerTriggerMode": "Manual",
    "imagesToCapture": {
      "documentWhiteLight": {
        "isEnabled": true
      },
      "documentInfraredLight": {
        "isEnabled": true
      },
      "documentUltravioletLight": {
        "isEnabled": true
      },
      "documentHolograms": {
        "isEnabled": true
      },
      "documentLightPassThrough": {
        "isEnabled": true
      },
      "selfieImage": {
        "isEnabled": true
      }
    },
    "processDocumentInputParams": {
      "dateFormat": "yyyy-MM-dd",
      "returnFieldsAoi": true,
      "returnFieldValidations": true,
      "returnFieldLabels": true,
      "returnCalculatedFields": true,
      "returnFrontImage": true,
      "returnBackImage": true,
      "returnFaceImage": true,
      "returnSignatureImage": true,
      "returnGhostFaceImage": true,
      "returnFaceImageLocation": true,
      "returnFrontImageLocation": true,
      "returnGhostFaceImageLocation": false,
      "returnSignatureLocation": false,
      "fetchWebFields": false,
      "returnDocumentForensicAuthentications": false,
      "shouldFailExpiredDocuments": true,
      "returnMatchBetweenPortraitAndGhost": false,
      "checkForSelfieLiveness": false,
      "performAddressValidation": false,
      "performPostalCodeValidation": false,
      "performIdentityVerification": false,
      "performAAMVADriverLicenseVerification": false,
      "performAgeVerification": false,
      "performKnowledgeBasedAuthentication": false,
      "performFullNameBreakdown": false,
      "ageLimit": 0,
      "checkForDocumentLiveness": false,
      "shouldHandleEmbeddedChip": false,
      "portraitReplacementThresholdScore": 0,
      "screenCaptureThresholdScore": 0,
      "paperPhotocopyThresholdScore": 0
    }
  })
});
const result = await response.json();

Responses