DocV Webhook Payload Reference

Field-by-field reference for the Predictive DocV webhook payloads, including documentVerification, documentData, and other DocV enrichment results.

This page documents the fields in the DocV webhook payloads delivered on evaluation_completed. Use it to look up a specific object — you don't need to read it end to end. For how to subscribe to webhooks and act on the decision, see Receive Results with DocV Webhooks.


Payload structure

Every evaluation_completed webhook wraps the evaluation in a four-key envelope. The evaluation details — including the final decision, tags, and enrichment results — are nested under data. The data.data_enrichments array holds the per-flow verification output documented in the rest of this page.

{
  "event_id": "336ccd2a-b3a8-49a8-b2cc-89a4ae90feeb",
  "event_at": "2025-08-27T16:16:23.104744158Z",
  "event_type": "evaluation_completed",
  "data": {
    "id": "test-1245",
    "workflow": "consumer_onboarding",
    "eval_id": "8770e076-f568-48a9-8201-dca13087e592",
    "decision": "ACCEPT",
    "status": "CLOSED",
    "sub_status": "Approved",
    "tags": ["DocV Accept"],
    "evaluation_status": "evaluation_completed",
    "review_queues": [],
    "data_enrichments": [
      { "...": "Per-flow verification output — see Enrichment results below." }
    ]
  }
}

Top-level fields

FieldTypeDescriptionExample
event_idString (UUID)Unique identifier for the webhook event."336ccd2a-b3a8-49a8-b2cc-89a4ae90feeb"
event_atStringRFC 3339 timestamp when the event was created."2025-08-27T16:16:23.104744158Z"
event_typeStringEvent type. Always "evaluation_completed" for this payload."evaluation_completed"
dataObjectEvaluation details, including the decision, tags, and enrichments.See data fields.

data fields

FieldTypeDescriptionExample
idStringCustomer-provided identifier for the evaluation."test-1245"
workflowStringWorkflow name for the evaluation use case."consumer_onboarding"
eval_idString (UUID)RiskOS™-generated unique evaluation ID. Use it to correlate the webhook with your records."8770e076-f568-48a9-8201-dca13087e592"
decisionStringFinal decision outcome. Use this as the primary routing field."ACCEPT"
decision_atStringRFC 3339 timestamp when the decision was finalized."2025-08-27T16:16:23.096676037Z"
statusStringCase status (for example, OPEN or CLOSED)."CLOSED"
sub_statusStringCase sub-status (for example, Approved or Surveillance)."Approved"
tagsArray of stringsTags associated with the evaluation. See data.tags.["DocV Accept"]
evaluation_statusStringProcessing status. Always "evaluation_completed" for this event."evaluation_completed"
review_queuesArray of stringsReview queues assigned to the evaluation.["Default Queue"]
data_enrichmentsArray of objectsPer-flow enrichment results. See Enrichment results.See Enrichment results.
📘

Two decision values, two formats:

The envelope data.decision is the final routing decision in uppercase (ACCEPT, REJECT, REVIEW). The DocV enrichment result has its own decision.value in lowercase (accept, reject, resubmit, review) that describes only the document analysis. Route on data.decision.


Enrichment results

Enrichment outputs are returned in the data.data_enrichments array.

FieldTypeDescriptionExample
enrichment_nameStringName of the enrichment executed as part of the evaluation."Socure DocV"
enrichment_endpointStringAPI endpoint used for the enrichment request."https://service.socure.com/api/5.0/documents/verify"
enrichment_providerStringProvider responsible for the enrichment."Socure"
status_codeIntegerHTTP status code returned by the enrichment provider.200
is_source_cacheBooleanWhether the enrichment result was served from cache.false
total_attemptsIntegerNumber of attempts made to complete the enrichment call.1
error_messageStringError detail returned by the provider, or an empty string on success.""
requestObjectPayload sent to the enrichment provider (often redacted in documentation examples).{ ... }
responseObjectEnrichment response payload. Contains a flow-specific result object — for example, documentVerification or secondaryDocument for DocV flowsSee the following response schemas.

documentVerification fields

FieldTypeDescriptionExample
transactionGroupIdString or nullIdentifier linking multiple related document verification transactions."6a95fcbd-4f42-4673-890f-ca90cd54f7f0"
scoresObjectDocV Omega model output, including the calibrated fraud score. See scores fields.{ "activeModelScore": 0.999 }
decisionObjectResult of the document verification analysis.See decision fields.
documentTypeObjectDetails about the document type provided for verification.See documentType fields.
documentDataObjectParsed data extracted from the submitted document.See documentData fields.
reasonCodesArray of stringsList of rule or insight codes returned from DocV analysis. See the reason code list.["<reason_code>", "<reason_code>"]
documentIntelligenceObjectDocV Omega document-intelligence signals. Field-level detail is documented in the Enrichment API Reference.{ ... }
biometricIntelligenceObjectDocV Omega biometric-intelligence signals. Field-level detail is documented in the Enrichment API Reference.{ ... }
captureIntelligenceObjectDocV Omega capture-intelligence signals. Field-level detail is documented in the Enrichment API Reference.{ ... }
rawDataObject or nullRaw data extracted from the document, including the mrz (Machine Readable Zone) string.{ "mrz": "P<USASMITH<<JANE<<<..." }
digitalIntelligenceObjectDevice and network telemetry captured during the DocV session. See Digital Intelligence.{ "device": { ... } }
graphIntelligenceObjectDocV Omega graph-intelligence signals. Field-level detail is documented in the Enrichment API Reference.{ ... }
👍

Tip:

reasonCodes are machine-readable flags that explain why a decision occurred (for example, data mismatches, capture issues, authenticity checks). They appear under data_enrichments.response.documentVerification.reasonCodes, and you can use them for routing, UX, and review workflows.

How to use them:

  • Drive resubmission UX (for example, prompt for glare removal if an image-quality code is present).
  • Route to manual review when authenticity or data-consistency codes indicate risk.
  • Log for audit and analytics.

The full catalog of reason codes and their descriptions is available in the reason code list.


documentType fields

FieldTypeDescriptionExample
typeStringHuman-readable document type. May return "Unknown" when the system doesn't support the document type or can't classify it."Drivers License"
countryStringCountry associated with the document type, in ISO 3166-1 alpha-3 format. May return "Unknown" when the country cannot be determined."USA"
stateStringState/region associated with the document type. May return "Unknown" when the state cannot be determined."NY"
⚠️

Handle "Unknown" values:

The documentType fields (type, country, or state) may return "Unknown" instead of a specific value. This occurs when the uploaded document type isn't supported or when the system cannot confidently extract or classify the document information from the submitted images. Design your integration to handle "Unknown" values and avoid assuming these fields always contain a recognized document type or region.

Supported document types

These are the document types you may encounter in documentVerification.documentType and when configuring capture flows. Coverage and acceptance may vary by country and program.

Document typeDescription
Drivers LicenseA government-issued license permitting the consumer to operate a motor vehicle.
Identification CardA non-driver government-issued photo ID for verifying identity.
PassportAn official government document certifying identity and nationality, used for international travel.
Employment Authorization CardA document issued by USCIS that proves authorization to work in the U.S.
Permanent Resident CardA document (for example, U.S. Green Card) proving the consumer's lawful permanent resident status.
Passport CardA wallet-sized U.S. document used for land and sea travel between certain countries.
Military IDAn ID card issued by a country's armed forces to identify active-duty or retired service members.
Health CardAn ID card issued by a government or insurer to access health services.
VisaAn official endorsement permitting the consumer to enter, stay, or work in a foreign country.
Social Security CardA U.S. government-issued card showing the consumer's Social Security Number (SSN).
Weapons LicenseA document permitting the consumer to carry or own firearms or other regulated weapons.
Tribal ID CardA government-recognized identity card issued by a Native American or Indigenous tribe.
Mexican Permanent Resident CardAn identity document for foreign nationals authorized to live permanently in Mexico.
UnknownReturned when the document type is not supported or can't be confidently classified.

scores fields

The scores object carries the DocV Omega model output. Decision on activeModelScore against a reject threshold you configure — see Configuring Decision Logic.

FieldTypeDescriptionExample
activeModelVersionStringVersion identifier of the active DocV Omega model that produced the score."0.1.0"
activeModelScoreNumberCalibrated fraud score from 0 to 1, where a higher value indicates greater fraud risk. This is the field your RiskOS™ workflows decision on.0.999

decision fields

The decision object is a legacy DocV field retained for backward compatibility with existing integrations. For DocV Omega, use activeModelScore as the primary fraud-risk output.

DocV Omega does not change decision.value. The decision object keeps its existing logic for backward compatibility, and DocV Omega adds the activeModelScore alongside it rather than replacing it, so activeModelScore and decision.value can point to different outcomes. Choose which signal drives your workflow — see Configuring Decision Logic.

📘

Recommendations only:

DocV responses are recommendations only. They inform your decision-making process and fit into your organization's broader risk strategy.

FieldTypeDescriptionExample
nameStringInternal label representing the configured decision rule set (for example, "lenient" or "strict")."lenient"
valueStringOutcome of the DocV analysis. One of:
• accept — Images met validation criteria and were verified.
• reject — Images failed some or all required validation criteria.
• resubmit — User must resubmit due to unacceptable image quality or missing data.
• review — Images did not meet configured criteria and should be manually reviewed. Returned only if enabled in your DocV Product Settings.
"reject"

documentData fields

The documentData object contains the data extracted from OCR, barcode, or MRZ.

📘

Missing documentData:

If DocV cannot extract sufficient information due to poor image quality or unreadable fields, the documentData object is not present, and the decision is resubmit.

FieldTypeDescriptionExample
personalNumberStringThe personal identifier value extracted from the ID, when applicable. Meaning and availability vary by country and document type, but it generally represents an identifier tied to the individual rather than the document itself (for example, a tax identification number or voter ID)."123456"
personalNumberTypeStringIndicates what the personal number represents. Supported values depend on the issuing country and document type."BRA_CPF"
nameSuffixStringThe name suffix extracted from the ID (for example, Jr., Sr., or III)."Jr"
firstNameStringFirst/given name parsed from the document."John"
surNameStringLast/family name parsed from the document."Smith"
fullNameStringFull name as printed on the document."John Smith"
addressStringSingle-line address string (as returned)."32194 N College Ave, New York City, NY 10001"
parsedAddressObjectStructured address parts extracted from address.See parsedAddress fields.
documentNumberStringDocument identifier/number."00000000"
dobStringDate of birth (YYYY-MM-DD)."1989-05-07"
issueDateStringDocument issue date (YYYY-MM-DD)."2021-01-12"
expirationDateStringDocument expiration date (YYYY-MM-DD)."2029-05-07"
customFieldsObjectAdditional document-specific fields extracted from the ID. Keys vary by document type and jurisdiction.{ "endorsements": "NONE", "restrictions": "B", "vehicleClass": "D" }
barcodeObjectIdentity and license details parsed from the barcode of a government-issued ID.See barcode fields.
sourcesObjectDocV Omega per-source extracted values (OCR, barcode, MRZ). Field-level detail is documented in the Enrichment API Reference.{ ... }

parsedAddress fields

FieldTypeDescriptionExample
physicalAddressStringPrimary street address (line 1) of the parsed location."32194 N College Ave"
physicalAddress2StringSecondary street address line."Apt 4B"
cityStringCity component extracted from the parsed address."New York City"
stateStringState, province, or regional code component extracted from the address."NY"
countryStringISO 3166-1 alpha-2 country code associated with the parsed address."US"
zipStringPostal or ZIP code component extracted from the parsed address."10001"

barcode fields

FieldTypeDescriptionExample
firstNameStringThe individual's given or first name as encoded in the barcode."John"
middleNameStringThe individual's middle name or initial extracted from the barcode."Larry"
surNameStringThe individual's last name or family name as encoded in the barcode."Smith"
nameSuffixStringAny name suffix present, such as Jr., Sr., II, or III."JR"
complianceTypeStringCode representing the license's compliance type (for example, Federal or state)."F"
licenseClassStringThe class or category of license (for example, commercial, operator)."C"

Example standard Document Verification webhook payload

This example shows a complete evaluation_completed payload for the standard Document Verification path, with the documentVerification result nested under data.data_enrichments[].response.

{
  "event_id": "a4c92f1e-8b3d-4a17-9c5e-f2d8e7b61a03",
  "event_at": "2025-08-27T16:16:23.104744158Z",
  "event_type": "evaluation_completed",
  "data": {
    "id": "test-1245",
    "workflow": "consumer_onboarding",
    "eval_id": "8770e076-f568-48a9-8201-dca13087e592",
    "decision": "ACCEPT",
    "status": "CLOSED",
    "sub_status": "Approved",
    "tags": ["Document Verification Triggered", "DocV Accept"],
    "evaluation_status": "evaluation_completed",
    "review_queues": [],
    "data_enrichments": [
      {
        "enrichment_name": "Socure DocV",
        "enrichment_endpoint": "https://service.socure.com/api/5.0/documents/verify",
        "enrichment_provider": "Socure",
        "status_code": 200,
        "is_source_cache": false,
        "total_attempts": 1,
        "error_message": "",
        "request": {},
        "response": {
          "documentVerification": {
            "reasonCodes": ["<reason_code>", "<reason_code>"],
            "documentType": {
              "type": "Drivers License",
              "country": "USA",
              "state": "NY"
            },
            "scores": {
              "activeModelVersion": "0.1.0",
              "activeModelScore": 0.02
            },
            "decision": {
              "name": "lenient",
              "value": "accept"
            },
            "documentData": {
              "firstName": "John",
              "surName": "Smith",
              "fullName": "John Smith",
              "dob": "1989-05-07",
              "address": "32194 N College Ave, Apt 4B, New York City, NY 10001",
              "parsedAddress": {
                "physicalAddress": "32194 N College Ave",
                "physicalAddress2": "Apt 4B",
                "city": "New York City",
                "state": "NY",
                "country": "US",
                "zip": "10001"
              },
              "documentNumber": "00000000",
              "issueDate": "2021-01-12",
              "expirationDate": "2029-05-07",
              "nameSuffix": "Jr",
              "customFields": {
                "endorsements": "NONE",
                "restrictions": "B",
                "vehicleClass": "D"
              }
            },
            "digitalIntelligence": {
              "device": {
                "id": "234ac3ff-3ed1-42de-8f33-8f332febfa54",
                "globalDeviceId": "123e4567-e89b-12d3-a456-426614174000",
                "sessionCreatedAt": "2024-12-23T18:06:52.248985937Z",
                "deviceCapturedAt": "2024-12-23T18:09:12.735992851Z",
                "computed": {
                  "statisticalId": "9349d69fef75cd356744293487462f8cd912",
                  "isVirtualMachine": false,
                  "isTamperedAndroidBuild": true,
                  "sessionAgeMinutes": 45,
                  "deviceNetworkTimezoneOffsetDiffMinutes": 60,
                  "hasBatteryFullStateMismatch": true,
                  "hasLowEntropyUserAgentClientHints": true
                },
                "network": {
                  "connectionIp": "38.48.122.126",
                  "forwardedForIps": [
                    "78.32.11.221",
                    "70.45.2.1"
                  ],
                  "webRtcPublicIp": "176.124.54.12",
                  "webRtcInternalIp": "192.168.1.85",
                  "realIp": "38.48.122.126",
                  "isTor": true,
                  "isProxy": true,
                  "isVpn": true,
                  "isConsumerPrivacy": true,
                  "isRiskyNetwork": true,
                  "isp": "comcast",
                  "ispType": "home",
                  "asn": 27364,
                  "asnName": "armstrong",
                  "domainName": "zoominternet.net",
                  "org": "comcast",
                  "isMobileCarrier": true,
                  "speed": "cable",
                  "networkLocation": {
                    "countryCode": "US",
                    "region": "WA",
                    "city": "Tacoma",
                    "postalCode": "98401",
                    "latitude": 47.2529001,
                    "longitude": -122.4443,
                    "metroCode": 819,
                    "continentCode": "na",
                    "timezoneName": "America/New_York",
                    "gmtOffset": "-0400"
                  }
                },
                "attributes": {
                  "sdkVersion": "3.0.1",
                  "platform": "iOS",
                  "os": "iOS",
                  "osVersion": "17",
                  "deviceModel": "iphone14,7",
                  "deviceManufacturer": "Apple",
                  "deviceType": "tablet",
                  "deviceMemory": 4.2,
                  "viewportWidth": 600,
                  "viewportHeight": 400,
                  "screenHeight": 1080,
                  "screenWidth": 1920,
                  "devicePixelRatio": 1.5,
                  "network": {
                    "vpnStatus": true
                  },
                  "location": {
                    "latitude": 41.50854591662628,
                    "longitude": -81.69534315646631,
                    "horizontalAccuracy": 2.1,
                    "altitude": 998.2,
                    "verticalAccuracy": 0,
                    "bearing": 32,
                    "bearingAccuracy": 2.1,
                    "speed": 1.3,
                    "speedAccuracy": 0.2
                  },
                  "battery": {
                    "batteryState": "charging",
                    "batteryLevel": 0.47
                  },
                  "timeZone": "America/New_York",
                  "timeZoneOffset": -480,
                  "language": "en-US",
                  "deviceArchitecture": "arm64",
                  "applicationType": "native",
                  "isEmulator": true,
                  "deviceContext": "homepage",
                  "androidAttributes": {
                    "isRooted": true,
                    "mobileNetwork": [
                      {
                        "carrierName": "T-Mobile",
                        "isoCountryCode": "us"
                      }
                    ]
                  },
                  "iOSAttributes": {
                    "isRooted": true,
                    "mobileNetwork": [
                      {
                        "carrierName": "T-Mobile",
                        "isoCountryCode": "us"
                      }
                    ]
                  },
                  "webAttributes": {
                    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36",
                    "userAgentExtractionRequired": true,
                    "browser": "Chrome",
                    "browserVersion": "116",
                    "pixelDepth": 0,
                    "hardwareConcurrency": 8,
                    "maxTouchPoints": 10,
                    "colorDepth": 24,
                    "webGlUnmaskedVendor": "Google Inc.",
                    "webGlUnmaskedRenderer": "ANGLE (Apple, ANGLE Metal Renderer: Apple M1 Pro, Unspecified Version)",
                    "viewportScale": 1
                  }
                },
                "history": {
                  "firstSeen": "2023-10-24T15:55:16.368Z",
                  "lastSeen": "2023-10-24T15:55:16.368Z",
                  "ips": [
                    "78.32.11.221",
                    "70.45.2.1"
                  ],
                  "isps": [
                    "RogersCable",
                    "T-Mobile"
                  ],
                  "daysSeen": [
                    "2023-10-24"
                  ],
                  "networkLocations": [
                    "chicago, il",
                    "new york, ny",
                    "paris, fr"
                  ]
                }
              },
              "behavioral": {
                "sessionId": "d34304a6-a726-4dec-b1cd-9c4a3c192a0d",
                "serverCreated": "2021-09-01T11:19:58.796Z",
                "serverUpdated": "2021-09-11T16:19:58.796Z",
                "duration": 120910,
                "source": "https://example.com/",
                "aggregations": {
                  "totalEventCount": 26,
                  "focusCount": 0,
                  "blurCount": 3,
                  "inputChangeCount": 6,
                  "submissionCount": 1,
                  "clickCount": 3,
                  "pasteCount": 0
                }
              },
              "velocityMetrics": {
                "historicalCount": {
                  "firstName": {
                    "uniqueCount": 1,
                    "uniqueSharePercent": 100
                  },
                  "surName": {
                    "uniqueCount": 1,
                    "uniqueSharePercent": 100
                  },
                  "email": {
                    "uniqueCount": 2,
                    "uniqueSharePercent": 87
                  },
                  "mobileNumber": {
                    "uniqueCount": 1,
                    "uniqueSharePercent": 100
                  }
                }
              },
              "latestNavigationContexts": [
                {
                  "tabId": "2b708463-9ef4-4166-ad47-5cb2309c1adc",
                  "combinedContext": "/checkout#step1",
                  "estimatedStartTimestamp": "2023-10-24T15:55:16.368Z",
                  "timeInContext": 0,
                  "timeInForeground": 0,
                  "ipAddresses": [
                    "127.0.0.1"
                  ],
                  "submissionCount": 0,
                  "backgroundCount": 0,
                  "android": {
                    "contextType": "fragment",
                    "contextAlias": "login-fragment"
                  }
                }
              ],
              "entityProfiler": [
                [
                  {
                    "entity": "+12223334444",
                    "entityType": "phone",
                    "profile": {
                      "seenCount": 2,
                      "firstSeen": "2025-08-24T14:15:22Z",
                      "lastSeen": "2025-11-12T09:12:15Z",
                      "deviceTypes": [
                        "phone",
                        "tablet"
                      ],
                      "deviceModels": [
                        "iphone14,7",
                        "GT70053G"
                      ],
                      "isps": [
                        "comcast",
                        "t-mobile"
                      ],
                      "languages": [
                        "en-us",
                        "es-us"
                      ],
                      "timezones": [
                        "america/new_york",
                        "america/los_angeles"
                      ],
                      "networkLocationStates": [
                        "ca",
                        "az"
                      ],
                      "networkLocationPostalCodes": [
                        "12345",
                        "56789"
                      ]
                    }
                  },
                  {
                    "entity": "[email protected]",
                    "entityType": "email",
                    "profile": {
                      "seenCount": 5,
                      "firstSeen": "2025-08-24T14:15:22Z",
                      "lastSeen": "2025-11-12T09:12:15Z",
                      "deviceTypes": [
                        "phone",
                        "desktop"
                      ],
                      "deviceModels": [
                        "moto g"
                      ],
                      "isps": [
                        "at&t"
                      ],
                      "languages": [
                        "en-us"
                      ],
                      "timezones": [
                        "america/los_angeles"
                      ],
                      "networkLocationStates": [
                        "or"
                      ],
                      "networkLocationPostalCodes": [
                        "56789"
                      ]
                    }
                  },
                  {
                    "entity": "111223333",
                    "entityType": "nationalId",
                    "profile": {
                      "seenCount": 3,
                      "firstSeen": "2025-08-24T14:15:22Z",
                      "lastSeen": "2025-11-12T09:12:15Z",
                      "deviceTypes": [
                        "phone",
                        "tablet"
                      ],
                      "deviceModels": [
                        "GT70053G"
                      ],
                      "isps": [
                        "comcast"
                      ],
                      "languages": [
                        "de_us"
                      ],
                      "timezones": [
                        "america/chicago"
                      ],
                      "networkLocationStates": [
                        "il"
                      ],
                      "networkLocationPostalCodes": [
                        "12345"
                      ]
                    }
                  }
                ]
              ]
            }
          }
        }
      }
    ]
  }
}

digitalIntelligence fields

The digitalIntelligence object carries the device, network, and behavioral telemetry Socure collects during the DocV session. It appears under data_enrichments[].response.documentVerification.digitalIntelligence.

FieldTypeDescriptionExample
deviceObjectDevice fingerprint, network analysis, device attributes, and historical device data.See device fields.
device.computedObjectServer-computed risk signals, such as statisticalId and isVirtualMachine.{ ... }
device.networkObjectIP analysis, proxy/VPN/Tor detection, ISP, ASN, and network location.{ ... }
device.attributesObjectDevice and browser attributes, including platform-specific androidAttributes, iOSAttributes, and webAttributes.{ ... }
device.historyObjectHistorical device tracking — recent IPs, ISPs, days seen, and network locations.{ ... }
behavioralObjectSession-level behavioral signals and interaction event counts.{ ... }
latestNavigationContextsArray of objectsBehavioral summary for the latest occurrence of each navigation context. Empty when no contexts apply.[ ... ]
velocityMetricsObjectDevice-level historical velocity metrics grouped by entity attribute. Empty when no metrics apply.{ ... }
entityProfilerArray of arraysGrouped historical profiles for each entity (email, phone, nationalId) associated with the device.[ [ ... ] ]

For the field-by-field breakdown of every digitalIntelligence object — device, computed, network, attributes, history, behavioral, latestNavigationContexts, velocityMetrics, and entityProfiler, including platform availability — see the Digital Intelligence Data Dictionary.


DocV Omega intelligence nodes

DocV Omega adds the documentIntelligence, biometricIntelligence, captureIntelligence, and graphIntelligence objects, along with documentData.sources, to the documentVerification response. Each one is present in the payload but its field-level detail is not published here — see the Enrichment API Reference.


secondaryDocument fields

When the evaluation runs a Secondary Document Capture flow, the result is nested under data_enrichments[].response.secondaryDocument instead of documentVerification.

FieldTypeDescriptionExample
transactionGroupIdStringIdentifier linking related document transactions. May be null."2b74fe41-bf69-484a-82c7"
decisionObjectResult of the secondary document analysis.See secondaryDocument.decision fields.
reasonCodesArray of stringsRule or insight codes explaining the result.See the reason code list.
documentsArray of objectsOne entry per uploaded document, with capture metadata.See documents fields.
documentObjectParsed details for a single secondary document, when extraction is available. May be null.See document fields.
digitalIntelligenceObjectDevice risk signals collected during capture. May be null.{ ... }
signalsObjectAdditional DocV signal data. May be null.{ ... }

secondaryDocument.decision fields

FieldTypeDescriptionExample
strategyStringConfigured decision rule set applied to the secondary document."lenient"
valueStringOutcome of the analysis. One of accept, reject, resubmit, or review."accept"

documents fields

Each object in the documents array describes one uploaded file.

FieldTypeDescriptionExample
typeStringDocument type label configured for the flow."Utility Bill"
namesArray of stringsNames detected on the document, when available.["Jane Doe"]
uploadedAtStringTimestamp when the document was uploaded."2026-05-01T12:34:56Z"
uploadsStringReference to the uploaded file or files. May be null."upload-7f2a"

document fields

The document object contains parsed data extracted from a single secondary document.

FieldTypeDescriptionExample
documentTypeStringType of the secondary document."Utility Bill"
namesArray of stringsNames parsed from the document.["Jane Doe"]
uploadedAtStringTimestamp when the document was uploaded."2026-05-01T12:34:56Z"
userDataObjectIdentity data extracted from the document. May be null.See document.userData fields.
documentDataObjectAdditional key-value data extracted from the document. Keys vary by document type.{ "accountNumber": "1234" }

document.userData fields
FieldTypeDescriptionExample
firstNameStringFirst/given name extracted from the document."Jane"
surNameStringLast/family name extracted from the document."Doe"
fullNameStringFull name as printed on the document."Jane Doe"
dobStringDate of birth (YYYY-MM-DD)."2000-05-01"
addressStringSingle-line address string."463 Mertz Motorway, Port Spencer, OH 65036"
parsedAddressObjectStructured address parts. Uses the same fields as the parsedAddress object documented above.See parsedAddress fields.

Related references


Did this page help you?