Socure RiskOS

https://help.socure.com/riskos
Admin
Socure RiskOS is an identity verification and fraud management platform that helps businesses verify...
Tokens:609,402
Snippets:5,253
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install SDK via CocoaPods

Source: https://help.socure.com/riskos/docs/digital-intelligence-ios-sdk

Add the dependency to your Podfile and run the installation command.

```ruby
use_frameworks!

pod `SocureDeviceRisk`
```

--------------------------------

### Example ACCEPT Decision Response

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This JSON response indicates an 'ACCEPT' decision for an evaluation, with the status 'CLOSED'. It includes tags that can be used to guide the onboarding flow, such as 'OTP Triggered' and 'OTP Approved'.

```json
{
    "eval_id": "8d455113-94f8-4bc2-82f6-e016e078f5dc",
    "decision": "ACCEPT",
    "status": "CLOSED",
    "sub_status": "Accept",
    "tags": [
        "OTP Triggered",
        "OTP Approved",
    ]
}
```

--------------------------------

### Full Content-Security-Policy example

Source: https://help.socure.com/riskos/docs/digital-intelligence-web-sdk

A complete example of a CSP header configured for compatibility with the Socure Digital Intelligence Web SDK.

```text
Content-Security-Policy: "connect-src 'self' https://*ingestion.dv*.socure.io; script-src 'self' https://sdk.dv.socure.io/"
```

--------------------------------

### Top-level Response ID Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

Example of the top-level ID field returned in the response.

```json
"DOCV-CASE-001234"
```

--------------------------------

### Initiation Delivery Response Example

Source: https://help.socure.com/riskos/docs/otp-integration-guide

An example of the response received after initiating a verification session, showing the decision, evaluation ID, status, and sub-status.

```json
{
  "decision": "REVIEW",
  "eval_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "ON_HOLD",
  "sub_status": "Pending OTP Code",
  "data_enrichments": [
    {

```

--------------------------------

### Decision Field Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

Example value for the decision field returned in a RiskOS evaluation.

```json
"REVIEW"
```

--------------------------------

### Example RiskOS Capture App Response

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This is an example response from the RiskOS Capture App when a workflow returns ON_HOLD. Inspect response tags and sub-status to determine the next step.

```json
{
  "eval_id": "d19fcb2d-3cde-4d3a-b25d-36d94a78db3e",
  "decision": "REVIEW",
  "status": "ON_HOLD",

```

--------------------------------

### Initiate Hosted Evaluation (cURL)

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

Use this cURL command to send a POST request to the Evaluation endpoint to start the hosted workflow. Ensure your API key and redirect_uri are correctly configured.

```curl
curl --request POST \
--url "https://riskos.sandbox.socure.com/api/evaluation" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--data '{ \
    "id": "17e9a02a-a5a7-442b-9b28-2034e1ed9d53", \
    "timestamp": "2025-08-14T20:10:04.535Z", \
    "workflow": "advanced_pre_fill", \
    "data": { \
        "individual": {     
          "docv": { \
              "config": { \
                  "send_message": true \
              } \
        }                     \
          "custom": { \
              "redirect_uri": "https://yourapp.com/callback" \
          } \
      } \
}'
```

--------------------------------

### RiskOS Evaluation Response Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

A sample JSON response object showing the structure of evaluation results, including phone risk scores and environment metadata.

```json
{
                      "__third_party_name__": "Socure Phone Risk",
                      "customerProfile": {
                          "userId": "ID_9a8fcc41-2ad9-4e4c-8a5c-f2b937406a9e"
                      },
                      "phoneRisk": {
                          "reasonCodes": [
                              "I601"
                          ],
                          "scores": [
                              {
                                  "name": "RiskPhoneUS.V7__Uniform.V1",
                                  "score": 0.87,
                                  "version": "4.0"
                              }
                          ]
                      },
                      "referenceId": "6dd703bf-b68e-40c9-8f30-6aca67a92205"
                  }
              },
              "eval_status": "evaluation_completed",
              "score": 11,
              "environment_name": "Sandbox",
              "redirect_uri": "https://riskos.sandbox.socure.com/hosted/99106d5e-84d6-4245-a42f-9ff364ab3067"
          }
```

--------------------------------

### REJECT Decision Example Response

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This JSON response indicates that the evaluation was rejected. It includes an evaluation ID, decision status, sub-status, and relevant tags.

```json
{
    "eval_id": "8d455113-94f8-4bc2-82f6-e016e078f5dc",
    "decision": "REJECT",
    "status": "COMPLETED",
    "sub_status": "Reject",
    "tags": [
      "Phone - High Risk",
      "Phone is Landline"
    ]
}
```

--------------------------------

### Socure Verify API Response Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This snippet illustrates a successful response from the Socure Verify API, including KYC field validations and source attribution. Note the 'reasonCodes' for potential issues.

```json
{
    "customerProfile": {
        "userId": "ID_df0fc504-d38f-4d0d-9d06-465b67fda478"
    },
    "kyc": {
        "fieldValidations": {
            "city": 0.99,
            "dob": 0.99,
            "firstName": 0.99,
            "mobileNumber": 0.99,
            "ssn": 0.99,
            "state": 0.99,
            "streetAddress": 0.99,
            "surName": 0.99,
            "zip": 0.99
        },
        "reasonCodes": [
            "I919"
        ],
        "sourceAttribution": [
            "Credit",
            "Government",
            "Education"
        ]
    },
    "referenceId": "346e3375-4072-402b-acd7-2d841ea2bf45"
}
```

--------------------------------

### Socure Verify API Request Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This snippet shows a typical request payload for the Socure Verify API, used for identity verification. Ensure all required fields are populated.

```json
{
    "city": "Deptford",
    "country": "US",
    "dob": "1992-07-26",
    "email": "maria.gonzalez@example.com",
    "firstName": "Maria",
    "mobileNumber": "+15678876227",
    "modules": [
        "kyc"
    ],
    "nationalId": "666609207",
    "parentTxnId": "b57f2998-e300-41a5-8dfa-d83454dc5076",
    "physicalAddress": "239 Roberts Ave",
    "riskOSId": "4b4c2372-7a3d-4303-9cc0-ce5415558044",
    "state": "NJ",
    "surName": "Gonzalez",
    "userId": "ID_df0fc504-d38f-4d0d-9d06-465b67fda478",
    "workflow": "non_hosted_advanced_pre_fill",
    "zip": "08096"
}
```

--------------------------------

### Example OTP SMS Delivery

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This snippet shows the structure of a data enrichment for delivering an OTP via SMS. It includes the endpoint, provider, request details, and the response containing a verification ID.

```json
{
    "enrichment_name": "Deliver OTP SMS",
    "enrichment_endpoint": "https://sandbox.socure.com/api/1.0/otp/send",
    "enrichment_provider": "SocureOTP",
    "status_code": 200,
    "request": {
        "channel": "sms",
        "destination": "+14257789900"
    },
    "response": {
        "verificationId": "769c5a5c-d426-4b6a-8b0c-758793043b1c"
    },
    "is_source_cache": false
}
```

--------------------------------

### Submit Full PII PATCH Request Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This cURL command demonstrates how to submit full PII data via a PATCH request to the Evaluation endpoint to continue the evaluation process. Ensure mandatory fields like given_name, family_name, and address.country are included.

```curl
curl -X PATCH "https://riskos.sandbox.socure.com/api/evaluation/{eval_id}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{

```

--------------------------------

### APPROVED Decision Example Response

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This JSON response indicates that the evaluation was approved. It includes an evaluation ID, decision status, and relevant tags.

```json
{
    "eval_id": "8d455113-94f8-4bc2-82f6-e016e078f5dc",
    "decision": "APPROVED",
    "status": "COMPLETED",
    "sub_status": "Approved",
    "tags": [
        "OTP Triggered",
        "OTP Approved",
        "Prefill Successful",
        "Approved to Display the Prefill Data",
        "Additional PII Requested"
    ]
}
```

--------------------------------

### ON_HOLD Decision Example Response

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This JSON response indicates that the evaluation is on hold, requiring more information. It includes an evaluation ID, decision status, sub-status, and relevant tags.

```json
{
    "eval_id": "8d455113-94f8-4bc2-82f6-e016e078f5dc",
    "decision": "REVIEW",
    "status": "ON_HOLD",
    "sub_status": "More information needed",
    "tags": [
        "OTP Triggered",
        "OTP Approved",
        "Prefill Successful",
        "Approved to Display the Prefill Data",
        "Additional PII Requested"
    ]
}
```

--------------------------------

### Socure Document Verification API Response Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This is a sample JSON response from the Socure Document Verification API. It includes details about the enrichment, the verification decision, document data, and digital intelligence.

```json
{
                  "enrichment_name": "Socure Document Verification",
                  "enrichment_endpoint": "https://service.socure.com/api/5.0/documents/verify",
                  "enrichment_provider": "Socure",
                  "status_code": 200,
                  "response": {
                  "referenceId": "ed6a5077-b272-4a75-8c21-b284e10927c",
                  "documentVerification": {
                      "decision": {
                      "name": "standard",
                      "value": "accept"
                      },
                      "reasonCodes": [
                      "I831",
                      "I836"
                      ],
                      "documentType": {
                      "type": "Drivers License",
                      "country": "USA",
                      "state": "NY"
                      },
                      "documentData": {
                      "firstName": "Test",
                      "surName": "User",
                      "fullName": "Test User",
                      "dob": "1990-01-01",
                      "documentNumber": "TST1234567",
                      "expirationDate": "2030-01-01"
                      },
                      "digitalIntelligence": {
                      "device": {
                          "id": "e92ee549-e3c7-4307-9be7-32fefb0db9a4",
                          "globalDeviceId": "aecddd42-f223-3333-940c-87baab4c6645",
                          "sessionCreatedAt": "2025-07-17T01:18:28Z",
                          "deviceCaptureAt": "2025-07-17T01:18:45Z",
                          "computed": {
                          "statisticalId": "b90c8faddcd15cd5eafc09bfe4e460d557c5e516f8c5b44b8d3ec1e6f60c30f8",
                          "isVirtualMachine": false,
                          "sessionAgeMinutes": 45
                          },
                          "network": {
                          "connectionIp": "203.0.113.10",
                          "webRtcPublicIp": "203.0.113.10",
                          "webRtcInternalIp": "10.0.0.15",
                          "realIp": "203.0.113.10",
                          "isTor": false,
                          "isProxy": false,
                          "isVpn": false,
                          "isConsumerPrivacy": false,
                          "isRiskyNetwork": false,
                          "isp": "Example ISP",
                          "ispType": "home",
                          "asn": 64500,
                          "asnName": "EXAMPLE-NET",
                          "domainName": "example.net",
                          "org": "Example Org",
                          "isMobileCarrier": false,
                          "speed": "broadband",
                          "networkLocation": {
                              "countryCode": "US",
                              "region": "NY",
                              "city": "New York",
                              "postalCode": "10001",
                              "latitude": 40.75,
                              "longitude": -73.99,
                              "metroCode": 501,
                              "continentCode": "NA",
                              "timezoneName": "America/New_York",
                              "gmtOffset": "-0500"
                          }
                          }
                      }
                      }
                  }
                  }
              }
              ]
          }
          }
          
```

--------------------------------

### Socure Document Request Response Example

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This JSON object illustrates a successful response from the Socure Document Request API. It contains a transaction token for document verification, an event ID, and a QR code for the user to scan.

```json
{
                      "enrichment_name": "Socure Document Request - Default Flow",
                      "enrichment_endpoint": "https://service.socure.com/api/5.0/documents/request",
                      "enrichment_provider": "SocureDocRequest",
                      "status_code": 200,
                      "request": {
                          "city": "DEPTFORD",
                          "country": "US",
                          "dob": "1992-07-26",
                          "firstName": "MARCIA",
                          "mobileNumber": "+15678876227",
                          "nationalId": "666609207",
                          "physicalAddress": "239 ROBERTS AVE",
                          "state": "NJ",
                          "surName": "GUTIERREZ",
                          "zip": "08096"
                      },
                      "response": {
                          "data": {
                              "docvTransactionToken": "2e6e2b35-910e-419e-9e02-cfb3adedc2e3",
                              "eventId": "2e6e2b35-910e-419e-9e02-cfb3adedc2e3",
                              "qrCode": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAZoAAAGaCAIAAAC5ZBI0AAALn0lEQVR42u3bwWHDMAwEQffftFNELOEOmP0zlkli5E8+X0la0ccWSMKZJOFMknAmSTiThDNJwpkk4UyScCYJZ5KEM0nCmSThTJJwJglnkoQzScKZJOFMEs4k6QRnn3U9uNGPfW7mbvznLzeeUeYzX5tBnOEMZzjDma3EGc5whjOc4QxnOMMZznCGMzOIM5zhDGc4s5U4QwPOcIYznOEMZzjDGc5wZgZxhjOceWacpYzoPlaeu5SZf7lxrxqxM4M4wxnOcIYzW4kznOEMZzjDGc5whjOc4QxnZhBnOMMZznBmK3GGM5zhDGc4wxnOcIYznOHMDOIMZzjDGc76BtgQJuzk1FNNlcnKtRnEGc5whjOc2Uqc4QxnOMMZznCGM5zhDGc4M4M4wxnOcIYzW4kznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnO0kmaOgVgtZ8gznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjMziDOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5wtu1yNF6dRrDs1e4TrHwB20qc4QxnOMMZzuwVznCGM5zhDGc4wxnOcIYznOEMZzjDma00ojjDGc5whjN7hTOc4QxnODODOMMZznCGM5yhwTPjTDhDA85whjOhAWc4wxnOPDPOcIYzNHhmnJlQnKHBM+MMZyFH2PgPFs/t5DWSGv/FbeqMzBHOcIYznOEMZzjDGc5w5hhwhjOc4QxnOMOZOcIZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOJu5splXZ9/n7ruymcPfOEf7XsA2C2c4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcAYOnOEMZzjDGc5whjOc4QxnOMMZznD2HmdKOOCxq1M4DI3IXvvBgTOc4Qxnvi/OcIYznOFMOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDmXCGM5zhDGc4wxnOcIYznOEMZx2cTW10478iXftXlX0j+llX5gniDGc4wxnOcIYzJ4gznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4Wz/iGaunbocjRRmDvC17zu1GzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOfsnZvsux7/tOQdn4VJk0XHup4AxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzh7j7OpS5l5sfYx2vh9992NzGfOfBEab5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4Wz/iE5dnX2DhJV8oKdedWNThjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEshLNGGvYN0j4oM4f/2isHZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4w1kKZ5mH1Ehw41M1Iovg3T8pcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5z98viNd8QBF9LQuBvXcP9GhjOc4QxnOMMZzowoznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIazlDGbwi6T0UZ0rH2HpM9QobuBM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOrMUZznCGM5zhDGc4wxnOcBbSvsuRyUrjPj/3uZm3vfF8p04BZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4w1nHpWy80I0UZr4YGl85mUA3rsUZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5whjOc4QxnOMMZznCGM5zhDGc4wxnOcIYznOEMZzjDGc5w9h5nU2v3MXqNwsaXyrWnCj1fnOEMZzjDGc5whjOc4QxnOMMZz
```

--------------------------------

### RiskOS ACCEPT Decision Example Response

Source: https://help.socure.com/riskos/docs/kyc-watchlist-screening-with-prefill-integration-guide-for-startups

This JSON response indicates an 'ACCEPT' decision from RiskOS, signifying that the user has passed all automated checks. It includes details about the workflow, evaluation, and data enrichments performed, such as Digital Intelligence.

```json
{
    "id": "b3c329ac-456f-4750-bfff-338a6ba3c1ad",
    "workflow": "non_hosted_advanced_pre_fill",
    "workflow_id": "331ceba3-bdb5-4303-8cc2-527fa96b9b74",
    "workflow_version": "1.17.0",
    "eval_source": "API",
    "eval_id": "606392d7-cdb4-4ce9-9ae9-5f258b4b787f",
    "eval_start_time": "2026-02-16T22:10:18.6056486Z",
    "eval_end_time": "2026-02-16T22:10:38.658848454Z",
    "decision": "ACCEPT",
    "decision_at": "2026-02-16T22:10:38.658604904Z",
    "status": "CLOSED",
    "sub_status": "Accept",
    "tags": [
        "OTP Triggered",
        "OTP Approved",
        "Prefill Successful",
        "Approved to Display the Prefill Data",
        "Additional PII Requested"
    ],
    "notes": "",
    "review_queues": [
        "Default Queue"
    ],
    "data_enrichments": [
        {
            "enrichment_name": "Socure Digital Intelligence",
            "enrichment_endpoint": "https://sandbox.socure.com/api/3.0/EmailAuthScore",
            "enrichment_provider": "Socure",
            "status_code": 200,
            "request": {
                "country": "US",
                "deviceSessionId": "6bdjhdsjbjs-5234ssd-37ae-4eb4-9ee5-b7fc5d7c1799-dfgjs-2t32bdbvcb-2bebcjwd",
                "dob": "1975-04-01",
                "mobileNumber": "+14257789900",
                "modules": [
                    "digitalintelligence"
                ],
                "parentTxnId": "606392d7-cdb4-4ce9-9ae9-5f258b4b787f",
                "riskOSId": "b3c329ac-456f-4750-bfff-338a6ba3c1ad",
                "userId": "ID_2013fb9a-d7d3-478e-845d-221647d6098b",
                "workflow": "non_hosted_advanced_pre_fill"
            },
            "response": {
                "customerProfile": {
                    "userId": "ID_2013fb9a-d7d3-478e-845d-221647d6098b"
                },
                "digitalIntelligence": {
                    "behavioral": {
                        "aggregations": {
                            "blurCount": 0,
                            "clickCount": 0,
                            "focusCount": 0,

```

--------------------------------

### Initialize and launch the SDK

Source: https://help.socure.com/riskos/docs/web-sdk

Configure the SDK parameters and trigger the launch function within the document body.

```html
<html>
  <head>
    <script src="https://websdk.socure.com/bundle.js"></script>
  </head>
  <body>
    <button onclick="start()">Start Verification</button>
    <div id="websdk"></div>

    <script>
      var config = {
        onProgress: function (event) {
          /* Called during capture */
        },
        onSuccess: function (response) {
          /* Called on success */
        },
        onError: function (error) {
          /* Called on error */
        },
        qrCodeNeeded: true, // Show QR code option
        disableSmsInput: false, // Enable SMS input
        closeCaptureWindowOnComplete: true, // Auto-close tab after document upload confirmation
        autoOpenTabOnMobile: true, // Skip "Continue on New Tab" screen on mobile and launch Capture App in a new tab
      };
      function start() {
        SocureDocVSDK.launch(
          'SDKKey',
          'docvTransactionToken',
          '#websdk',
          config[optional]
        );
      }
    </script>
  </body>
</html>
```

--------------------------------

### Install Cocoapods Dependencies

Source: https://help.socure.com/riskos/docs/react-native-ios

Navigate to the 'ios' directory of your project and run 'pod install' to install all the necessary Cocoapods dependencies, including the Socure DocV wrapper.

```bash
cd ios
pod install
```

--------------------------------

### Implement onCreate Initialization

Source: https://help.socure.com/riskos/docs/hosted-flows-android

Sets up views, configures the WebView, and attaches click listeners for verification and closing the flow.

```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    // Initialize views
    webView = findViewById(R.id.webview)
    landingScreen = findViewById(R.id.landingScreen)
    verifyButton = findViewById(R.id.verifyButton)
    closeButton = findViewById(R.id.closeButton)

    // Setup WebView
    setupWebView()

    // Setup button listeners
    verifyButton.setOnClickListener {
        if (isCameraPermissionGranted()) {
            startVerification()
        } else {
            requestPermissionLauncher.launch(Manifest.permission.CAMERA)
        }
    }

    closeButton.setOnClickListener {
        closeWebView()
    }
}
```

--------------------------------

### Initialize and Launch the SDK

Source: https://help.socure.com/riskos/docs/ios-sdk

Initialize the DocV SDK with the necessary options and launch the verification flow.

```APIDOC
## Initialize and Launch the SDK

### Description
To enable the DocV SDK functionality, add the following code to your app. This function initializes the SDK with provided options and launches the document verification process.

### Method
Swift function call

### Endpoint
N/A

### Parameters
#### Request Body
- **options** (SocureDocVOptions) - Required - Configuration object for the SDK.
  - **publicKey** (String) - Required - The unique SDK key obtained from RiskOS™.
  - **docVTransactionToken** (String) - Required - The transaction token retrieved from the `/api/evaluation` endpoint.
  - **presentingViewController** (UIViewController) - Required - The current view controller presenting the SDK UI.
  - **useSocureGov** (Bool) - Optional - A Boolean flag indicating whether to use the GovCloud environment. Defaults to `false`.

### Request Example
```swift
func onButtonTapped() {
    let options = SocureDocVOptions(
        publicKey: "da3e907d-c5dd-41cb-80ee-xxxxxxxxxxxx",
        docVTransactionToken: "78d1c86d-03a3-4e11-b837-71a31cb44142",
        presentingViewController: self,
        useSocureGov: false
    )

    SocureDocVSDK.launch(options) { (result: Result<SocureDocVSuccess, SocureDocVFailure>) in
        switch result {
        case .success(let success):
            print("Flow succeeded: \(success)")
        case .failure(let failure):
            print("Flow failed due to \(failure)")
        }
    }
}
```

### Response
#### Success Response (Result.success)
- **deviceSessionToken** (String?) - A unique identifier for the session used for accessing device details.
```

--------------------------------

### Error Response Example

Source: https://help.socure.com/riskos/docs/otp-integration-guide

Example of an error response when maximum verification attempts are reached.

```APIDOC
### Error Response Example (400 Bad Request)

```json
{
  "status": 400,
  "error": "Bad Request",
  "message": "Max verify attempts reached"
}
```
```

--------------------------------

### Initialize DocV Web SDK

Source: https://help.socure.com/riskos/docs/document-verification-integration-guide-for-startups

Include the SDK script and launch the verification flow using your SDK key and transaction token.

```html
<html>
    <head>
    <script src="https://websdk.socure.com/bundle.js"></script>
    </head>
    <body>
    <button onclick="start()">Start Verification</button>
    <div id="websdk"></div>

    <script>
        var config = {
        onProgress: function (event) {
            /* Called during capture */
        },
        onSuccess: function (response) {
            /* Called on success */
        },
        onError: function (error) {
            /* Called on error */
        },
        qrCodeNeeded: true, // Show QR code option
        disableSmsInput: false, // Enable SMS input
        closeCaptureWindowOnComplete: true, // Auto-close tab after document upload confirmation
        autoOpenTabOnMobile: true, // Skip "Continue on New Tab" screen on mobile and launch Capture App in a new tab
        };
        function start() {
        SocureDocVSDK.launch(
            'SDKKey', // Replace with your SDK Key
            'docvTransactionToken', // Replace with the docvTransactionToken
            '#websdk',
            config[optional]
        );
        }
    </script>
    </body>
</html>
```

--------------------------------

### Reference ID Example

Source: https://help.socure.com/riskos/docs/integrating-with-riskos

Example of a unique identifier string used in RiskOS workflows.

```text
"4b905868-9d20-4d1c-9fde-544aeede981f"
```

--------------------------------

### Initialize and Launch DocV SDK

Source: https://help.socure.com/riskos/docs/android-sdk

This code initializes the SDK and registers a callback to handle the result. It's recommended to check for camera and file permissions before launching.

```kotlin
class Activity : AppCompatActivity() {

    private lateinit var startForResult: ActivityResultLauncher<Intent>

    override fun onCreate(savedInstanceState: Bundle?) {
        ... 

        startForResult = registerForActivityResult(
            ActivityResultContracts.StartActivityForResult() 
        ) { result: ActivityResult ->
            result.data?.let { data ->
                SocureSdk.getResult(data) { sdkResult ->
                    Log.d(TAG, "onResult called: $sdkResult")

                    if (sdkResult is SocureDocVSuccess) {
                        Log.d(
                            TAG,
                            "success: ${sdkResult.deviceSessionToken}"
                        )
                    } else {
                        val error = sdkResult as? SocureDocVFailure
                        Log.d(
                            TAG,
                            "error: ${error?.deviceSessionToken}, " +
                            "${error?.error}"
                        )
                    }
                }
            }
        }

        // Launch the SDK using the intent
        startForResult.launch(
            SocureSdk.getIntent(
                context,
                SocureDocVContext(
                    docvTransactionToken,
                    SDKKey,
                    useSocureGov
                )
            )
        )
    }
}
```

--------------------------------

### initializeSDK() Configuration

Source: https://help.socure.com/riskos/docs/digital-intelligence-react-native-wrapper

Configuration options for initializing the SDK.

```APIDOC
## initializeSDK() Configuration

### Description
Options passed to the initializeSDK() method to customize SDK operation.

### Parameters
#### Request Body
- **omitLocationData** (boolean) - Optional - Omit location data from collection. Defaults to false.
- **advertisingID** (string) - Optional - Advertising ID information to be sent. Defaults to null.
- **useSocureGov** (boolean) - Optional - Configure SDK to communicate with SocureGov backend. Defaults to false.
- **configBaseUrl** (string) - Optional - Custom base URL for retrieving SDK configuration.
- **customerSessionId** (string) - Optional - Customer provided identifier used in place of the SDK generated session token.

### Request Example
{
  "omitLocationData": false,
  "advertisingID": "example-id",
  "useSocureGov": false,
  "configBaseUrl": "https://api.example.com",
  "customerSessionId": "session-123"
}
```

--------------------------------

### Initialize View Controller

Source: https://help.socure.com/riskos/docs/hosted-flows-ios

Configures the initial view state and triggers the setup for the WebView and landing screen.

```swift
override func viewDidLoad() {
    super.viewDidLoad()
    self.view.backgroundColor = .systemBackground
    setupWebView()
    setupLandingScreen()
}
```
Tokens:
Raw