Verification

Get session configuration

Changed on
get/v1/verification/sessions/{sessionId}/config

Request

Path parameters

sessionIdstring required

Response

Session configuration with document requirements

idstring required
organizationIdstring required
customerIdstring nullable required
associatedEntityIdstring nullable

Associated entity ID. Present when this is a UBO KYC session.

customerNamestring nullable

Customer/business name. Present when this is a UBO KYC session.

verificationSubtypestring required
countryCodestring required
emailstring required
namestring required
statusstring required
expiresAtstring required
completedAtstring nullable required
submittedAtstring nullable required
completedStepsstring[] required
requiredStepsstring[] required
estimatedCompletionTimeMinutesnumber nullable required
collectedDataobject required
providerDataobject nullable required
providerSessionIdstring nullable required
verificationUrlstring nullable required
metadataobject required
fillOnBehalfboolean required
createdAtstring required
updatedAtstring required
featureFlagsstring[] required

Feature flags enabled for the organization

deviceRiskSessionKeystring nullable

Server-generated session key for device-intelligence collection on the hosted verification UI. Absent when the integration is not configured.

partnerDeviceRiskSessionKeystring nullable

Server-generated session key for partner-operator device intelligence on fill-on-behalf sessions. Omitted unless the partner-device integration applies.

bankPartnerAgreementsRequiredboolean required

Whether additional banking agreements must be accepted

platformFxAgreementsRequiredboolean required

Whether platform FX terms must be accepted in the agreements step

Example response

{
  "associatedEntityId": "asp_abc123",
  "customerName": "Acme Corporation",
  "featureFlags": [
    "socuredocv",
    "advanced-reporting"
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status