{"openapi":"3.0.3","info":{"title":"Socure RiskOS™ API","version":"2025-01-01.orion","license":{"name":"Proprietary","url":"https://socure.com"},"description":"*RiskOS™ documentation site is Socure confidential and proprietary information, and is only intended for viewing by authorized persons.*\n\nThe Socure RiskOS™ APIs provide a unified API framework for risk evaluation. They use predictable, resource-oriented URLs, accept JSON-formatted request bodies, return JSON-formatted responses, and follow standard HTTP methods, status codes, and authentication practices.\n\nYou can test RiskOS™ APIs in the **Sandbox environment**, which allows you to simulate requests without impacting live data. The request endpoint determines whether the request is directed to the Sandbox or Production (live) environment.\n","contact":{"name":"Socure Support","url":"https://help.socure.com","email":"support@socure.com"}},"servers":[{"url":"https://riskos.socure.com","description":"Production","x-environment":"production"},{"url":"https://riskos.sandbox.socure.com","description":"Sandbox (for testing; nothing is saved)","x-environment":"sandbox"}],"security":[{"BearerAuth":[]}],"tags":[{"name":"Evaluation","description":"The Evaluation API is the primary endpoint for performing Risk Evaluations in RiskOS™. \nRequests must include data that conforms to the schema defined for the specific Solution.\nSuccessful evaluation responses include a `decision` value from the following list: * `ACCEPT`: The evaluation is approved; proceed with fulfillment/onboarding and the happy‑path experience.<br /> * `REVIEW`: Additional assessment is required; route to manual review and/or configured step‑up checks per workflow logic.<br /> * `REJECT`: The evaluation has failed the required checks and the entity is rejected.\n> **Note:** **`ACCEPT`**, **`REVIEW`**, and **`REJECT`** are the default decision values. Customers can customize the response to added or to delete default values based on specific workflow needs."},{"name":"Feedback","description":"Use the Feedback APIs to submit decision feedback, either individually or in bulk, to enhance fraud detection models and improve decision accuracy."},{"name":"Outcome","description":"Use the Evaluation Outcome API to report what happened after a RiskOS™ evaluation: the final decision (`evaluation_decisions`), feedback for specific products (`account_intelligence`, `watchlist`, `docv`, `kyc`), or both."},{"name":"Reason Codes","description":"Use the Reason Codes API to retrieve the catalog of reason codes available to your account, including each code's name, provider, description, and product. Filter the catalog by product, name, free text, or active status."},{"name":"Custom Watchlist","description":"Use the Custom Watchlist API to manage records on your own custom watchlists — add, update, or soft-delete entries that RiskOS™ screens and monitors against, using the same matching engine that powers Socure's Watchlist Screening and Monitoring. Create the list in the RiskOS™ Dashboard first, then manage its records with this API."}],"paths":{"/api/evaluation":{"post":{"tags":["Evaluation"],"summary":"Start an Evaluation","operationId":"postEvaluation","security":[{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/XApiVersionHeader"}],"description":"Submit a new evaluation in RiskOS™. Select the evaluation type below to view the corresponding request schema.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ConsumerOnboarding"},{"$ref":"#/components/schemas/AdvancedPrefill"},{"$ref":"#/components/schemas/GenericPassthrough"},{"$ref":"#/components/schemas/TrustAndSafety"},{"$ref":"#/components/schemas/BankAccountVerification"},{"$ref":"#/components/schemas/BusinessOnboarding"},{"$ref":"#/components/schemas/AccountTakeover"},{"$ref":"#/components/schemas/WorkforceVerification"},{"$ref":"#/components/schemas/PaymentScreening"},{"$ref":"#/components/schemas/AgeAssurance"}]},"examples":{"Consumer Onboarding":{"$ref":"#/components/examples/ConsumerOnboardingRequest"},"Advanced Prefill":{"$ref":"#/components/examples/OnboardingWithAdvancedPrefillRequest"},"Generic Passthrough":{"$ref":"#/components/examples/GenericPassthroughRequest"},"Trust and Safety":{"$ref":"#/components/examples/TrustAndSafetyRequest"},"Bank Account Verification":{"$ref":"#/components/examples/BankAccountVerificationRequest"},"Business Onboarding":{"$ref":"#/components/examples/BusinessOnboardingRequest"},"Login and Authentication":{"$ref":"#/components/examples/AccountTakeOverRequest"},"Workforce Verification":{"$ref":"#/components/examples/WorkforceVerificationRequest"},"Payment Screening":{"$ref":"#/components/examples/PaymentScreeningIndividualRequest"},"Age Assurance":{"$ref":"#/components/examples/AgeAssuranceRequest"}}}}},"responses":{"200":{"description":"The request was processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalResponseWithOutSocureData"},"examples":{"Consumer Onboarding":{"$ref":"#/components/examples/ConsumerOnboardingResponse"},"Advanced Prefill":{"$ref":"#/components/examples/OnboardingWithAdvancedPrefillResponse"},"Generic Passthrough":{"$ref":"#/components/examples/GenericPassthroughResponse"},"Trust and Safety":{"$ref":"#/components/examples/TrustAndSafetyResponse"},"Bank Account Verification":{"$ref":"#/components/examples/BankAccountVerificationResponse"},"Business Onboarding":{"$ref":"#/components/examples/BusinessOnboardingResponse"},"Login and Authentication":{"$ref":"#/components/examples/AccountTakeOverResponse"},"Workforce Verification":{"$ref":"#/components/examples/WorkforceVerificationResponse"},"Payment Screening":{"$ref":"#/components/examples/PaymentScreeningIndividualResponse"},"Age Assurance":{"$ref":"#/components/examples/AgeAssuranceResponse"}}}}},"201":{"description":"The evaluation was accepted and is paused pending an asynchronous step.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalResponseWithOutSocureData"},"examples":{"partialSuccessExample":{"summary":"Example 201 Response (Business Onboarding)","value":{"id":"BIZ-9876","eval_id":"8a4f6c12-3b9e-4d07-9f2c-e5a1b7d8f3c4","workflow":"business_onboarding","eval_status":"evaluation_paused","decision":"REVIEW","status":"OPEN","sub_status":"Pending Docs","workflow_id":"4a2288ff-b3a8-4e69-89dd-069d5e2bcb44","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:30:24.456771162Z","data_enrichments":[{"enrichment_name":"Deliver OTP SMS","enrichment_endpoint":"https://sandbox.socure.com/api/1.0/otp/send","enrichment_provider":"SocureOTP","status_code":200,"request":{"channel":"email","destination":"darshanvaishnav24@gmail.com"},"response":{"error":"","verificationId":"5ac71c12-32df-4fb2-ab76-5493444f3f97"},"is_source_cache":false},{"enrichment_name":"Verify OTP SMS","enrichment_endpoint":"https://sandbox.socure.com/api/1.0/otp/verify","enrichment_provider":"SocureOTP","status_code":200,"request":{"otp":"508070","verificationId":"5ac71c12-32df-4fb2-ab76-5493444f3f97"},"response":{"attemptCount":1,"error":"","status":"approved","verificationId":"5ac71c12-32df-4fb2-ab76-5493444f3f97"},"is_source_cache":false},{"enrichment_name":"Socure Address risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"city":"bakersfield","country":"US","deviceSessionId":"234ac3ff-3ed1-42de-8f33-8f332febfa54","dob":"1990-05-17","email":"johnsmith123+test@example.com","modules":["addressrisk"],"nationalId":"454236793"},"response":{"addressRisk":{"reasonCodes":["I704","I705","I708"],"scores":[{"name":"addressrisk_cus1","score":0.01,"version":"10.0"},{"name":"address_risk_pri","score":0.01,"version":"9.0"}]},"referenceId":"4ca693ee-af2a-45ef-9688-834683ac1b34"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"SocureCNam","enrichment_endpoint":"https://sandbox.socure.com/api/2.0/cnam","enrichment_provider":"SocureCNam","status_code":200,"request":{"phoneNumber":"+1-312-555-1234"},"response":{"callerName":"Alice Johnson","callerType":"BUSINESS","countryCode":"US","phoneNumber":"+1-415-555-5678","valid":true},"is_source_cache":false,"total_attempts":1}]}}}}}},"400":{"description":"Bad Request – The request was invalid or cannot be otherwise served.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized – No valid API key provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden – IP address was rejected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found – The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Payload Too Large – The `customer_metadata` object exceeds the maximum allowed size.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too Many Requests – The rate limit for this API has been exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal Server Error – An unexpected condition occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/evaluation/monitoring":{"post":{"x-environment":["production"],"tags":["Evaluation"],"summary":"Enroll an Evaluation in Watchlist Monitoring","operationId":"watchlistMonitoring","security":[{"BearerAuth":[]}],"parameters":[{"$ref":"#/components/parameters/XApiVersionHeader"}],"description":"Enable or disable daily watchlist monitoring for an existing evaluation. Monitored entities are checked automatically for additions, modifications, or removals across specified lists.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reference_id","list_type","operation"],"properties":{"reference_id":{"type":"string","format":"uuid","description":"Unique identifier assigned to a Watchlist enrichment after a RiskOS™ workflow is finalized. You can retrieve this value from the response of a successful call to the Evaluation endpoint.\n","example":"ae94dd2e-46fe-4e58-bf0b-45ef1d4588a2"},"list_type":{"type":"string","enum":["watchlist"],"description":"Specifies the type of monitoring list to which the entity (identified by its enrichment `referenceId`) will be subscribed.\nPassing `watchlist` enables monitoring for changes across all watchlist types defined in your Monitoring policy.\n","example":"watchlist"},"operation":{"type":"string","enum":["enable","disable"],"description":"Specifies the action to be taken for monitoring enrollment.\n- `enable`: Activates Watchlist Monitoring for the specified evaluation.\n- `disable`: Deactivates Watchlist Monitoring for the specified evaluation.         \n","example":"enable"}}}}}},"responses":{"200":{"description":"The request was processed successfully.","content":{"application/json":{"schema":{"type":"object","required":["success","monitoring_status"],"properties":{"success":{"type":"boolean","description":"Indicates whether the monitoring enrollment operation was successful.","example":true},"monitoring_status":{"type":"string","enum":["enabled","disabled"],"description":"Current status of the monitoring subscription after the operation has been processed.\n","example":"enabled"}}}}}},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"403":{"description":"Forbidden - The client does not have permission to access this resource."},"404":{"description":"Not Found - The requested resource does not exist."},"500":{"description":"Internal Server Error – Unexpected server issue."}}}},"/api/evaluation/{eval_id}":{"patch":{"tags":["Evaluation"],"summary":"Partially Update an Evaluation","operationId":"patchEvaluation","security":[{"BearerAuth":[]}],"description":"Update risk data or metadata for a paused evaluation identified by `eval_id`. Partial updates are supported — omitted fields remain unchanged. Completed evaluations are immutable.\n","parameters":[{"$ref":"#/components/parameters/EvalId"},{"$ref":"#/components/parameters/XApiVersionHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ConsumerOnboardingPatch"},{"$ref":"#/components/schemas/AdvancedPrefill"},{"$ref":"#/components/schemas/GenericPassthrough"},{"$ref":"#/components/schemas/TrustAndSafety"},{"$ref":"#/components/schemas/BankAccountVerification"},{"$ref":"#/components/schemas/BusinessOnboarding"},{"$ref":"#/components/schemas/AccountTakeover"},{"$ref":"#/components/schemas/WorkforceVerification"},{"$ref":"#/components/schemas/PaymentScreening"},{"$ref":"#/components/schemas/AgeAssurance"}],"description":"A subset of the request body used in flows such as Consumer Onboarding, Business Onboarding, and Bank Account Verification.\n"},"examples":{"updateEmail":{"$ref":"#/components/examples/PatchUpdateEmail"},"updatePhone":{"$ref":"#/components/examples/PatchUpdatePhone"},"updateDevice":{"$ref":"#/components/examples/PatchUpdateDevice"},"trustAndSafetyUpdateEmail":{"$ref":"#/components/examples/PatchTrustAndSafety"},"loginAuthenticationSubmitOtp":{"$ref":"#/components/examples/PatchLoginAndAuthentication"},"Advanced Prefill":{"$ref":"#/components/examples/PatchAdvancedPrefill"},"Generic Passthrough":{"$ref":"#/components/examples/PatchGenericPassthrough"},"Bank Account Verification":{"$ref":"#/components/examples/PatchBankAccountVerification"},"Business Onboarding":{"$ref":"#/components/examples/PatchBusinessOnboarding"},"Workforce Verification":{"$ref":"#/components/examples/PatchWorkforceVerification"},"Payment Screening":{"$ref":"#/components/examples/PatchPaymentScreening"},"Age Assurance":{"$ref":"#/components/examples/PatchAgeAssurance"}}}}},"responses":{"200":{"description":"The evaluation was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalResponseWithOutSocureData"},"examples":{"patchSuccessExample":{"summary":"Example 200 Response","value":{"id":"onb-12345","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"consumer_onboarding","eval_status":"evaluation_in_process","decision":"REVIEW","status":"OPEN","sub_status":"Verification Pending","eval_start_time":"2024-12-02T10:30:00.123Z","eval_end_time":"2024-12-02T10:32:00.456Z","tags":["none"],"score":51,"review_queues":["Default Queue"],"data_enrichments":[{"enrichment_name":"Socure Phone Risk","enrichment_provider":"Socure","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","status_code":200,"response":{"referenceId":"68bb36f1-7e32-4600-bebf-26a6cdd39f8b"},"is_source_cache":false,"total_attempts":1}]}}}}}},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"404":{"description":"Not Found - The requested resource does not exist."},"413":{"description":"Payload Too Large - The `customer_metadata` object exceeds the maximum allowed size."},"500":{"description":"500 Internal Server Error – Unexpected server issue."}}},"get":{"tags":["Evaluation"],"summary":"Retrieve Evaluation Data","operationId":"getEvaluation","security":[{"BearerAuth":[]}],"description":"Retrieves evaluation data for a workflow by providing the unique `eval_id`.\n","parameters":[{"$ref":"#/components/parameters/EvalId"},{"$ref":"#/components/parameters/XApiVersionHeader"},{"name":"include_input","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Set to `true` to include the original input data and any transformed data in the response under the `input` field.\n"}],"responses":{"200":{"description":"The evaluation was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalResponseWithOutSocureData"},"examples":{"getSuccessExample":{"summary":"Example Response","value":{"id":"onb-12345","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"consumer_onboarding","eval_status":"evaluation_completed","decision":"ACCEPT","status":"OPEN","sub_status":"Accept","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":["none"],"score":51,"review_queues":["Default Queue"],"data_enrichments":[{"enrichment_name":"Socure Address risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"city":"bakersfield","country":"US","deviceSessionId":"234ac3ff-3ed1-42de-8f33-8f332febfa54","dob":"1990-05-17","email":"johnsmith123+test@example.com","modules":["addressrisk"],"nationalId":"454236793"},"response":{"addressRisk":{"reasonCodes":["I704","I705","I708"],"scores":[{"name":"addressrisk_cus1","score":0.01,"version":"10.0"},{"name":"address_risk_pri","score":0.01,"version":"9.0"}]},"referenceId":"4ca693ee-af2a-45ef-9688-834683ac1b34"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Email Risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["emailrisk"],"email":"johnsmith123+test@example.com"},"response":{"emailRisk":{"reasonCodes":["I520","I555"],"scores":[{"name":"email_risk_cus1","score":0.01,"version":"10.0"}]},"referenceId":"92201637-1ec8-46b4-9537-236971eb6f9b"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Phone Risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["phonerisk"],"email":"johnsmith123+test@example.com"},"response":{"phoneRisk":{"reasonCodes":["I618","I608"],"scores":[{"name":"RiskPhoneUS.V6.Norm.V1","score":0.01,"version":"6.0"}]},"referenceId":"68bb36f1-7e32-4600-bebf-26a6cdd39f8b"},"is_source_cache":false,"total_attempts":1}]}}}}}},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"404":{"description":"Not Found - The requested resource does not exist."},"429":{"description":"Too Many Requests - The rate limit for this API has been exceeded."},"500":{"description":"Internal Server Error – An unexpected condition occurred on the server."}}}},"/api/evaluation/{eval_id}/documents":{"get":{"tags":["Evaluation"],"summary":"Download Evaluation Documents","operationId":"downloadEvaluationDocuments","security":[{"BearerAuth":[]}],"description":"Retrieve a ZIP archive of documents associated with an evaluation, including user-uploaded identity documents and reviewer-added case attachments.\n","parameters":[{"$ref":"#/components/parameters/EvalId"},{"$ref":"#/components/parameters/XApiVersionHeader"}],"responses":{"200":{"description":"A ZIP archive containing the requested documents.","content":{"application/zip":{"schema":{"type":"string","format":"binary"},"example":"zip <binary>"}},"headers":{"Content-Disposition":{"description":"Specifies the filename of the returned ZIP archive.","schema":{"type":"string","example":"attachment; filename=\"{eval_id}_document.zip\""}}}},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"403":{"description":"Forbidden - The client does not have permission to access this resource."},"404":{"description":"Not Found - The requested resource does not exist."},"500":{"description":"Internal Server Error – An unexpected condition occurred on the server."}}}},"/api/evaluation/{eval_id}/state":{"put":{"tags":["Evaluation"],"summary":"Update an Evaluation State","operationId":"updateEvaluationState","security":[{"BearerAuth":[]}],"description":"Updates evaluation metadata, including `decision`, `status`, and `sub_status`, and optionally adds notes or a base64-encoded attachment.\n","parameters":[{"$ref":"#/components/parameters/EvalId"},{"$ref":"#/components/parameters/XApiVersionHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"title":"Update Decision","type":"object","required":["workflow","decision"],"properties":{"workflow":{"type":"string","example":"consumer_onboarding","description":"Your environment-specific workflow identifier. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"decision":{"type":"string","description":"The new decision value to apply.","enum":["ACCEPT","REJECT","REVIEW","RESUBMIT","CANCEL"],"example":"REVIEW"},"tags":{"type":"string","description":"Comma-separated list of tags to apply to the evaluation.","example":"high_risk,email_risk"},"queue":{"type":"string","description":"The review queue to assign the evaluation to.","example":"Default Queue"},"notes":{"type":"string","description":"Optional notes to add context to the evaluation.","example":"Verification documents pending re-check"},"attachments":{"type":"array","description":"An array of base64-encoded attachment files.","items":{"type":"object","properties":{"file_name":{"type":"string","example":"case.jpeg"},"file_data":{"type":"string","format":"byte","example":"ZmlsZWRhdGE="}}}}}},{"title":"Update Status","type":"object","required":["workflow","status","sub_status"],"properties":{"workflow":{"type":"string","example":"consumer_onboarding","description":"Your environment-specific workflow identifier. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"status":{"type":"string","description":"The new status to apply.","enum":["OPEN","CLOSED","ON_HOLD"],"example":"OPEN"},"sub_status":{"type":"string","description":"An optional sub-status providing more detail (e.g., `In Review`).","example":"In Review"},"tags":{"type":"string","description":"Comma-separated list of tags to apply to the evaluation.","example":"high_risk,email_risk"},"queue":{"type":"string","description":"The review queue to assign the evaluation to.","example":"Default Queue"},"notes":{"type":"string","description":"Optional notes to add context to the evaluation.","example":"Verification documents pending re-check"},"attachments":{"type":"array","description":"An array of base64-encoded attachment files.","items":{"type":"object","properties":{"file_name":{"type":"string","example":"case.jpeg"},"file_data":{"type":"string","format":"byte","example":"ZmlsZWRhdGE="}}}}}}]}}}},"responses":{"200":{"description":"The evaluation state was updated successfully. No response body is returned."},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"403":{"description":"Forbidden - IP Address was rejected."},"404":{"description":"Not Found - The requested resource does not exist."},"500":{"description":"Internal Server Error – An unexpected condition occurred on the server."}}}},"/api/feedback":{"put":{"tags":["Feedback"],"operationId":"FeedbackAPI","parameters":[{"$ref":"#/components/parameters/XApiVersionHeader"}],"security":[{"BearerAuth":[]}],"summary":"Feedback Update","description":"Allows you to programmatically provide feedback to an existing evaluation in RiskOS™.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","workflow","fraud_label"],"properties":{"id":{"type":"string","example":"9876543","description":"The customer-side identifier (`id`) provided during the original evaluation request."},"workflow":{"type":"string","example":"consumer_onboarding","description":"The environment-specific Workflow identifier that the ID is associated with. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"fraud_label":{"type":"string","example":"fraud","enum":["fraud","non-fraud"],"description":"The fraud label for an application. Accepted values are `fraud` and `non-fraud`."},"fraud_type":{"type":"string","example":"synthetic","description":"The fraud typology or category that best describes the nature of the fraud."},"notes":{"type":"string","description":"Optional notes or additional information to be added to the case."},"recorded_at":{"type":"string","example":"2022-05-19","format":"date","description":"The date when the event was recorded. Use the `YYYY-MM-DD` format as defined by the [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) full-date standard. If omitted, defaults to the current date."},"recorded_by":{"type":"string","example":"John Doe","description":"The name or identifier of the person who recorded the fraud. If omitted, defaults to the authenticated user."},"tags":{"type":"array","items":{"type":"string"},"example":["tag1","tag2"],"description":"Tags to categorize or label the fraud case. Useful for filtering, reporting, or internal tracking. Tags are validated against the namespace's configured tag definitions. If any tag is invalid, the request returns a `400` error."}}},"example":{"id":"9876543","workflow":"consumer_onboarding","fraud_label":"fraud","fraud_type":"synthetic","notes":"This is a synthetic fraud case","recorded_at":"2022-05-19","recorded_by":"John Doe","tags":["tag1","tag2"]}}}},"responses":{"200":{"description":"OK - Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudFeedbackResponse"}}}},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"404":{"description":"Not Found - The requested resource does not exist."},"429":{"description":"Too Many Requests - The rate limit for this API has been exceeded.                                                                                 "},"500":{"description":"Internal Server Error – An unexpected condition occurred on the server."}}}},"/api/feedback/import":{"post":{"tags":["Feedback"],"operationId":"FeedbackUpdateCSV","parameters":[{"$ref":"#/components/parameters/XApiVersionHeader"}],"security":[{"BearerAuth":[]}],"summary":"Feedback Import","description":"Allows you to upload a CSV file to provide programmatic feedback to RiskOS™.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"CSV file containing feedback records.\n\nThe file must contain **8 columns in the required order**.\nA header row is required, but header names are ignored.\n\nSee the endpoint description for the full CSV format specification.\n"}}}}}},"responses":{"200":{"description":"OK - Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudFeedbackImportResponse"}}}},"400":{"description":"Bad Request - The request was unacceptable."},"401":{"description":"Unauthorized - An invalid API key was provided."},"404":{"description":"Not Found - The requested resource does not exist. The client should not repeat this request without modification."},"429":{"description":"Too Many Requests - The rate limit for this API has been exceeded."},"500":{"description":"Internal Server Error – An unexpected condition occurred on the server."}}}},"/api/outcome_contribution":{"post":{"tags":["Outcome"],"operationId":"EvaluationOutcomeAPI","security":[{"BearerAuth":[]}],"summary":"Submit Outcome Contribution","description":"Contribute evaluation level outcome and product-specific outcome data to RiskOS™ after an evaluation has completed. ","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["event_timestamp","eval_id"],"properties":{"event_timestamp":{"type":"string","format":"date-time","description":"When the decision became final, or when fraud was confirmed. ISO 8601.","example":"2024-01-15T10:30:00Z"},"eval_id":{"type":"string","description":"The ID of the RiskOS™ evaluation this contribution is about.","example":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","maxLength":255},"customer_user_id":{"type":"string","description":"An institution- or account-specific unique identifier. The same `customer_user_id` can be used for a given client across multiple `eval_id`s.","example":"customer_123","maxLength":255},"notes":{"type":"string","description":"Free-form notes.","example":"Post-review fraud confirmation","maxLength":255},"tags":{"type":"array","items":{"type":"string"},"description":"Your own labels for this contribution. 255 characters in total, across all tags.","example":["manual-review"]},"evaluation_decisions":{"type":"object","description":"The final decision for the evaluation and whether it was fraud.","required":["initial_decision","final_decision","fraud_outcome","label_source"],"properties":{"initial_decision":{"type":"string","description":"Initial decision.","enum":["accept","reject","refer","resubmit","review","error","cancelled"],"example":"reject"},"final_decision":{"type":"string","description":"Final decision.","enum":["approve","reject","cancelled"],"example":"reject"},"fraud_outcome":{"type":"string","description":"Whether the evaluation turned out to be fraud.","enum":["fraud","suspected fraud","not fraud"],"example":"fraud"},"fraud_type":{"type":"string","description":"The type of fraud. Required when fraud_outcome is \"fraud\" or \"suspected fraud\". Optional when fraud_outcome is \"not fraud\". When provided with any fraud_outcome, must be one of the allowed values; any other value is rejected with CONTRACT_VALIDATION_FAILED.","enum":["first party fraud","synthetic fraud","third party fraud","account takeover","other fraud"],"example":"third party fraud"},"fraud_subtype":{"type":"string","description":"Subtype of fraud for more granular classification within the primary `fraud_type`. Accepts any value.","example":"identity theft","maxLength":255},"label_source":{"type":"string","description":"How the label was produced.","enum":["manual","systematic"],"example":"manual"},"conversion_flag":{"type":"string","description":"Indicates the final lending evaluation outcome and captures relevant onboarding details.","enum":["booked","declined","withdrawn"],"example":"declined"},"delinquency_bucket":{"type":"string","maxLength":255,"description":"Indicates the customer's delinquency status. Send as a string; a JSON number is rejected with `INVALID_JSON`.","example":"18"},"loss_amount_number":{"type":"string","description":"Loss amount. Send as a string. A JSON number (e.g. 250.00) is also accepted and treated as the same value. Accepts US-style (\"1,234.56\") and European-style (\"1.234,56\") formats, including negative values such as \"-596.23\" and \"-1.234,56\". A leading \"+\", spaces, and currency symbols are not accepted. The maximum is 13 characters, including the minus sign.","example":"596.23","pattern":"^-?(?:\\d+(?:,\\d+)*(?:\\.\\d+)?|\\d+(?:\\.\\d+)*,\\d+)$","maxLength":13},"loss_amount_currency":{"type":"string","description":"Three-letter ISO 4217 currency code, such as USD.","example":"USD","pattern":"^[A-Z]{3}$"},"channel":{"type":"string","description":"Channel.","enum":["web","mobile","branch","ATM","phone","other"],"example":"mobile"},"account_details":{"type":"object","description":"Optional. Include only when account-related information needs to be supplied. When present, `account_type` is required and the remaining fields are optional. Do not send an empty object.","required":["account_type"],"properties":{"account_type":{"type":"string","description":"Account type.","enum":["checking","savings","investment","gaming","other"],"example":"checking"},"account_number":{"type":"string","description":"External account number.","example":"546876945","maxLength":255},"routing_number":{"type":"string","description":"Routing number.","example":"546834213","maxLength":255},"open_timestamp":{"type":"string","format":"date-time","description":"When the account was opened. Use ISO-8601 format.","example":"1993-09-12T20:11:12Z"},"closed_timestamp":{"type":"string","format":"date-time","description":"When the account was closed. Use ISO-8601 format.","example":"2020-09-13T00:00:00Z"},"closed_reason":{"type":"string","description":"Close reason. Accepts any value.","example":"fraud","maxLength":255}},"additionalProperties":false}},"additionalProperties":false},"account_intelligence":{"type":"object","description":"Feedback for Account Intelligence. If you include this section, its required fields must be filled in.","required":["payment_direction","payment_outcome","payment_return_code","payment_return_date","payment_return_reason","payment_date","payment_type","payment_amount"],"properties":{"evaluation_usecase":{"type":"string","description":"What the original evaluation was for, such as opening an account or making a payment. Use `payment` for payment decisions.","enum":["account_opening","payment","purchase","account_changes","account_funding"],"example":"payment"},"payment_direction":{"type":"string","description":"Direction of the payment.","enum":["inbound","outbound"],"example":"outbound"},"payment_outcome":{"type":"string","description":"Outcome of the payment transaction.","enum":["Good","Bad","Pending","Fraud"],"example":"Good"},"payment_return_code":{"type":"string","description":"The ACH/payment return code if the payment was returned. Use `#` or `NO_RETURN` if not returned.","example":"NO_RETURN","maxLength":255},"payment_return_date":{"type":"string","format":"date-time","description":"The date the payment was returned, if applicable. Use ISO-8601 format.","example":"2025-04-23T00:00:00Z"},"payment_return_reason":{"type":"string","description":"The reason the payment was returned, if applicable.","example":"None","maxLength":255},"payment_date":{"type":"string","format":"date-time","description":"The date the payment was initiated or processed. Use ISO-8601 format.","example":"2025-04-21T00:00:00Z"},"payment_type":{"type":"string","description":"The type of payment instrument used.","enum":["ACH","Wire","Card","Check","P2P","RTP","FedNow"],"example":"ACH"},"payment_amount":{"type":"string","description":"The dollar amount of the payment. Send as a string. A JSON number (e.g. 250.00) is also accepted and treated as the same value. Accepts US-style (\"1,234.56\") and European-style (\"1.234,56\") formats, including negative values such as \"-596.23\" and \"-1.234,56\". A leading \"+\", spaces, and currency symbols are not accepted. The maximum is 13 characters, including the minus sign.","example":"250.00","pattern":"^-?(?:\\d+(?:,\\d+)*(?:\\.\\d+)?|\\d+(?:\\.\\d+)*,\\d+)$","maxLength":13},"additional_fields":{"type":"object","description":"Extra fields of your own, as a JSON object. Up to 32 KiB.","additionalProperties":true}},"additionalProperties":false},"watchlist":{"type":"object","description":"Feedback for Watchlist. If you include this section, its required fields must be filled in.","required":["reference_id","entity_id","decision"],"properties":{"reference_id":{"type":"string","description":"The reference_id from the Watchlist result of the original evaluation.","example":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","maxLength":255},"entity_id":{"type":"array","items":{"type":"string"},"description":"Watchlist matched entity identifier(s).","example":["ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc"]},"decision":{"type":"string","description":"Final decision specific to watchlist screening.","enum":["match","no match"],"example":"no match"},"notes":{"type":"string","description":"Free-form notes.","maxLength":255},"additional_fields":{"type":"object","description":"Extra fields of your own, as a JSON object. Up to 32 KiB.","additionalProperties":true}},"additionalProperties":false},"docv":{"type":"object","description":"Feedback for DocV. If you include this section, its required fields must be filled in.","required":["final_doc_v_reason"],"properties":{"final_doc_v_reason":{"type":"string","description":"DocV decision reasons, separated by commas.","example":"document liveness","maxLength":255},"doc_v_reasons_subtype":{"type":"string","description":"DocV reason subtypes. Accepts any value.","example":"mismatched","maxLength":255},"additional_fields":{"type":"object","description":"Extra fields of your own, as a JSON object. Up to 32 KiB.","additionalProperties":true}},"additionalProperties":false},"kyc":{"type":"object","description":"Feedback for KYC. If you include this section, its required fields must be filled in.","properties":{"deceased_flag":{"type":"string","enum":["true","false"],"description":"The individual's deceased status. Send the string `\"true\"` or `\"false\"`, not a JSON boolean.","example":"true"},"deceased_timestamp":{"type":"string","format":"date-time","description":"Time when the deceased flag was first known to be true. Use ISO-8601 format.","example":"2026-09-04T13:30:00Z"},"additional_fields":{"type":"object","description":"Extra fields of your own, as a JSON object. Up to 32 KiB.","additionalProperties":true}},"additionalProperties":false}},"anyOf":[{"required":["evaluation_decisions"]},{"required":["watchlist"],"not":{"anyOf":[{"required":["account_intelligence"]},{"required":["docv"]},{"required":["kyc"]}]}}],"additionalProperties":false},"examples":{"1. Evaluation Identifier + Evaluation Decisions":{"summary":"1. Decisions","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile"}}},"2. Evaluation Identifier + Evaluation Decisions + Account Details":{"summary":"2. Decisions + account","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile","account_details":{"account_type":"checking","account_number":"546876945","routing_number":"546834213","open_timestamp":"1993-09-12T20:11:12Z","closed_timestamp":"2020-09-13T00:00:00Z","closed_reason":"fraud"}}}},"3. Evaluation Identifier + Evaluation Decisions + product sections":{"summary":"3. Decisions + Watchlist + KYC","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile"},"watchlist":{"reference_id":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","entity_id":["ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc"],"decision":"match","notes":"Analyst confirmed true match","additional_fields":{"review_queue":"fraud-ops"}},"kyc":{"deceased_flag":"true","deceased_timestamp":"2026-09-04T13:30:00Z","additional_fields":{"review_queue":"fraud-ops"}}}},"4. Evaluation Identifier + Evaluation Decisions + Account Details + product sections":{"summary":"4. Decisions + account + products","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile","account_details":{"account_type":"checking","account_number":"546876945","routing_number":"546834213","open_timestamp":"1993-09-12T20:11:12Z","closed_timestamp":"2020-09-13T00:00:00Z","closed_reason":"fraud"}},"account_intelligence":{"evaluation_usecase":"payment","payment_direction":"outbound","payment_outcome":"Fraud","payment_return_code":"R10","payment_return_date":"2025-04-23T00:00:00Z","payment_return_reason":"Customer advises not authorized","payment_date":"2025-04-21T00:00:00Z","payment_type":"ACH","payment_amount":"596.23","additional_fields":{"review_queue":"fraud-ops"}},"watchlist":{"reference_id":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","entity_id":["ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc"],"decision":"match","notes":"Analyst confirmed true match","additional_fields":{"review_queue":"fraud-ops"}},"docv":{"final_doc_v_reason":"document liveness","doc_v_reasons_subtype":"mismatched","additional_fields":{"review_queue":"fraud-ops"}},"kyc":{"deceased_flag":"true","deceased_timestamp":"2026-09-04T13:30:00Z","additional_fields":{"review_queue":"fraud-ops"}}}},"5. Evaluation Identifier + Watchlist only":{"summary":"5. Watchlist only","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"watchlist":{"reference_id":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","entity_id":["ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc"],"decision":"no match","notes":"Analyst cleared false positive","additional_fields":{"review_queue":"fraud-ops"}}}},"6. Watchlist only (fails)":{"summary":"6. No eval ID (fails)","value":{"customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"watchlist":{"reference_id":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","entity_id":["ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc"],"decision":"no match","notes":"Analyst cleared false positive","additional_fields":{"review_queue":"fraud-ops"}}}},"7. Evaluation Identifier + other product sections without Evaluation Decisions (fails)":{"summary":"7. Products, no decisions (fails)","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"watchlist":{"reference_id":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","entity_id":["ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc"],"decision":"match","notes":"Analyst confirmed true match","additional_fields":{"review_queue":"fraud-ops"}},"kyc":{"deceased_flag":"true","deceased_timestamp":"2026-09-04T13:30:00Z","additional_fields":{"review_queue":"fraud-ops"}}}},"8. Missing Evaluation Identifier (fails)":{"summary":"8. No timestamp (fails)","value":{"eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile"}}},"9. Evaluation Identifier only (fails)":{"summary":"9. Eval ID only (fails)","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"]}},"10. Missing fraud type (fails)":{"summary":"10. No fraud_type (fails)","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile"}}},"11. Unknown field (fails)":{"summary":"11. Unknown field (fails)","value":{"version":"v1","event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"reject","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile"}}},"12. Bad enum (fails)":{"summary":"12. Bad enum (fails)","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"evaluation_decisions":{"initial_decision":"review","final_decision":"accept","fraud_outcome":"fraud","fraud_type":"third party fraud","fraud_subtype":"identity theft","label_source":"manual","conversion_flag":"declined","delinquency_bucket":"18","loss_amount_number":"596.23","loss_amount_currency":"USD","channel":"mobile"}}},"13. Incomplete Watchlist (fails)":{"summary":"13. Watchlist incomplete (fails)","value":{"event_timestamp":"2024-01-15T10:30:00Z","eval_id":"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb","customer_user_id":"customer_123","notes":"Post-review fraud confirmation","tags":["manual-review"],"watchlist":{"reference_id":"10c50ad1-8aba-42b4-ab56-8f9ad582777b","decision":"maybe","notes":"Analyst review pending","additional_fields":{"review_queue":"fraud-ops"}}}}}}}},"responses":{"202":{"description":"Accepted - The contribution was validated and accepted for processing.","content":{"application/json":{"schema":{"type":"object","required":["status","contribution_id"],"properties":{"status":{"type":"string","example":"accepted"},"contribution_id":{"type":"string","format":"uuid","description":"UUID that identifies the accepted contribution. Customers can quote it to Socure support when asking about a specific submission."}}},"examples":{"row1":{"summary":"1. Decisions","value":{"status":"accepted","contribution_id":"3f6c2a9e-8d41-4b7a-9c2e-1a5f0d7b6e21"}},"row2":{"summary":"2. Decisions + account","value":{"status":"accepted","contribution_id":"3f6c2a9e-8d41-4b7a-9c2e-1a5f0d7b6e21"}},"row3":{"summary":"3. Decisions + Watchlist + KYC","value":{"status":"accepted","contribution_id":"3f6c2a9e-8d41-4b7a-9c2e-1a5f0d7b6e21"}},"row4":{"summary":"4. Decisions + account + products","value":{"status":"accepted","contribution_id":"3f6c2a9e-8d41-4b7a-9c2e-1a5f0d7b6e21"}},"row5":{"summary":"5. Watchlist only","value":{"status":"accepted","contribution_id":"3f6c2a9e-8d41-4b7a-9c2e-1a5f0d7b6e21"}}}}}},"400":{"description":"Bad Request - The request body is empty, has no `eval_id`, is not valid JSON or contains an unknown field (`INVALID_JSON`), or has missing or invalid fields (`CONTRACT_VALIDATION_FAILED`). For `CONTRACT_VALIDATION_FAILED`, `details` lists each field to fix.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Error with a `code`. For `CONTRACT_VALIDATION_FAILED`, `details` lists each field to fix.","required":["status","code","message"],"properties":{"status":{"type":"string","description":"Always `error` for an error response.","example":"error"},"code":{"type":"string","description":"Machine-readable error code.","enum":["INVALID_JSON","CONTRACT_VALIDATION_FAILED","INTERNAL_ERROR"],"example":"CONTRACT_VALIDATION_FAILED"},"message":{"type":"string","description":"Human-readable summary. For `CONTRACT_VALIDATION_FAILED`, the message is `one or more fields failed validation` and `details` lists each failing field. For `INVALID_JSON`, the message is the parser error.","example":"one or more fields failed validation"},"details":{"type":"array","description":"Field-level validation failures. Returned for `CONTRACT_VALIDATION_FAILED`. Not returned for `INVALID_JSON`.","items":{"type":"object","required":["field","reason"],"properties":{"field":{"type":"string","description":"Path of the failing field, such as `evaluation_decisions.final_decision`. Empty when the rule applies to the contribution as a whole.","example":"evaluation_decisions.final_decision"},"reason":{"type":"string","description":"Why the field failed. Ends with the ID of the failed rule in brackets.","example":"must be one of [approve, reject, cancelled] [final_decision]"}}}}},"title":"Validation error","example":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"event_timestamp","reason":"is required [event_timestamp.required]"}]}},{"title":"Simple error","type":"object","description":"Error with only an `error` message. If Socure has enabled the standard error format for your account, it also includes `code` and `error_details`.","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","example":"eval_id is required in the request body"},"code":{"type":"string","description":"Standard error format only. Empty for these errors.","example":""},"error_details":{"type":"object","description":"Standard error format only.","properties":{"status":{"type":"integer","description":"HTTP status code.","example":400},"request_id":{"type":"string","description":"Identifier of the API call, when available."}}}}}]},"examples":{"row6":{"summary":"6. No eval ID (fails)","value":{"error":"eval_id is required in the request body"}},"row7":{"summary":"7. Products, no decisions (fails)","value":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"","reason":"evaluation_decisions is required unless the only enrichment is watchlist [evaluation_decisions.when_required]"}]}},"row8":{"summary":"8. No timestamp (fails)","value":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"event_timestamp","reason":"is required [event_timestamp.required]"}]}},"row9":{"summary":"9. Eval ID only (fails)","value":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"","reason":"evaluation_decisions is required unless the only enrichment is watchlist [evaluation_decisions.when_required]"}]}},"row10":{"summary":"10. No fraud_type (fails)","value":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"evaluation_decisions","reason":"fraud_type is required unless fraud_outcome is 'not fraud' [fraud_type.required_unless_not_fraud]"}]}},"row11":{"summary":"11. Unknown field (fails)","value":{"status":"error","code":"INVALID_JSON","message":"unmarshal outcome request: proto: (line 1:2): unknown field \"version\""}},"row12":{"summary":"12. Bad enum (fails)","value":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"evaluation_decisions.final_decision","reason":"must be one of [approve, reject, cancelled] [final_decision]"}]}},"row13":{"summary":"13. Watchlist incomplete (fails)","value":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"one or more fields failed validation","details":[{"field":"watchlist.entity_id","reason":"is required [entity_id.required]"},{"field":"watchlist.decision","reason":"must be one of [match, no match] [decision]"}]}}}}}},"401":{"description":"Unauthorized - A missing or invalid API key was provided."},"403":{"description":"Forbidden - The API key is not permitted to perform this action."},"404":{"description":"Not Found - The `eval_id` does not match an evaluation in your account and environment.","content":{"application/json":{"schema":{"title":"Simple error","type":"object","description":"Error with only an `error` message. If Socure has enabled the standard error format for your account, it also includes `code` and `error_details`.","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","example":"evaluation not found in caller namespace"},"code":{"type":"string","description":"Standard error format only. Empty for these errors.","example":""},"error_details":{"type":"object","description":"Standard error format only.","properties":{"status":{"type":"integer","description":"HTTP status code.","example":404},"request_id":{"type":"string","description":"Identifier of the API call, when available."}}}}},"examples":{"evaluation_not_found":{"summary":"Evaluation not found","value":{"error":"evaluation not found in caller namespace"}}}}}},"413":{"description":"Payload Too Large - The request body exceeds 160 KiB."},"429":{"description":"Too Many Requests - The rate limit for this API has been exceeded."},"500":{"description":"Internal Server Error - An unexpected condition occurred on the server (`INTERNAL_ERROR`)."}},"x-readme":{"code-samples":[{"language":"shell","name":"1. Decisions","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\"\n  }\n}'","correspondingExample":"row1"},{"language":"shell","name":"2. Decisions + account","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\",\n    \"account_details\": {\n      \"account_type\": \"checking\",\n      \"account_number\": \"546876945\",\n      \"routing_number\": \"546834213\",\n      \"open_timestamp\": \"1993-09-12T20:11:12Z\",\n      \"closed_timestamp\": \"2020-09-13T00:00:00Z\",\n      \"closed_reason\": \"fraud\"\n    }\n  }\n}'","correspondingExample":"row2"},{"language":"shell","name":"3. Decisions + Watchlist + KYC","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\"\n  },\n  \"watchlist\": {\n    \"reference_id\": \"10c50ad1-8aba-42b4-ab56-8f9ad582777b\",\n    \"entity_id\": [\n      \"ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc\"\n    ],\n    \"decision\": \"match\",\n    \"notes\": \"Analyst confirmed true match\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  },\n  \"kyc\": {\n    \"deceased_flag\": \"true\",\n    \"deceased_timestamp\": \"2026-09-04T13:30:00Z\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  }\n}'","correspondingExample":"row3"},{"language":"shell","name":"4. Decisions + account + products","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\",\n    \"account_details\": {\n      \"account_type\": \"checking\",\n      \"account_number\": \"546876945\",\n      \"routing_number\": \"546834213\",\n      \"open_timestamp\": \"1993-09-12T20:11:12Z\",\n      \"closed_timestamp\": \"2020-09-13T00:00:00Z\",\n      \"closed_reason\": \"fraud\"\n    }\n  },\n  \"account_intelligence\": {\n    \"evaluation_usecase\": \"payment\",\n    \"payment_direction\": \"outbound\",\n    \"payment_outcome\": \"Fraud\",\n    \"payment_return_code\": \"R10\",\n    \"payment_return_date\": \"2025-04-23T00:00:00Z\",\n    \"payment_return_reason\": \"Customer advises not authorized\",\n    \"payment_date\": \"2025-04-21T00:00:00Z\",\n    \"payment_type\": \"ACH\",\n    \"payment_amount\": \"596.23\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  },\n  \"watchlist\": {\n    \"reference_id\": \"10c50ad1-8aba-42b4-ab56-8f9ad582777b\",\n    \"entity_id\": [\n      \"ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc\"\n    ],\n    \"decision\": \"match\",\n    \"notes\": \"Analyst confirmed true match\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  },\n  \"docv\": {\n    \"final_doc_v_reason\": \"document liveness\",\n    \"doc_v_reasons_subtype\": \"mismatched\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  },\n  \"kyc\": {\n    \"deceased_flag\": \"true\",\n    \"deceased_timestamp\": \"2026-09-04T13:30:00Z\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  }\n}'","correspondingExample":"row4"},{"language":"shell","name":"5. Watchlist only","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"watchlist\": {\n    \"reference_id\": \"10c50ad1-8aba-42b4-ab56-8f9ad582777b\",\n    \"entity_id\": [\n      \"ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc\"\n    ],\n    \"decision\": \"no match\",\n    \"notes\": \"Analyst cleared false positive\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  }\n}'","correspondingExample":"row5"},{"language":"shell","name":"6. No eval ID (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"watchlist\": {\n    \"reference_id\": \"10c50ad1-8aba-42b4-ab56-8f9ad582777b\",\n    \"entity_id\": [\n      \"ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc\"\n    ],\n    \"decision\": \"no match\",\n    \"notes\": \"Analyst cleared false positive\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  }\n}'","correspondingExample":"row6"},{"language":"shell","name":"7. Products, no decisions (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"watchlist\": {\n    \"reference_id\": \"10c50ad1-8aba-42b4-ab56-8f9ad582777b\",\n    \"entity_id\": [\n      \"ZaP+/U4QdD5dfmJNCjtmwzKDgOyECzc\"\n    ],\n    \"decision\": \"match\",\n    \"notes\": \"Analyst confirmed true match\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  },\n  \"kyc\": {\n    \"deceased_flag\": \"true\",\n    \"deceased_timestamp\": \"2026-09-04T13:30:00Z\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  }\n}'","correspondingExample":"row7"},{"language":"shell","name":"8. No timestamp (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\"\n  }\n}'","correspondingExample":"row8"},{"language":"shell","name":"9. Eval ID only (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ]\n}'","correspondingExample":"row9"},{"language":"shell","name":"10. No fraud_type (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\"\n  }\n}'","correspondingExample":"row10"},{"language":"shell","name":"11. Unknown field (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"version\": \"v1\",\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"reject\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\"\n  }\n}'","correspondingExample":"row11"},{"language":"shell","name":"12. Bad enum (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"evaluation_decisions\": {\n    \"initial_decision\": \"review\",\n    \"final_decision\": \"accept\",\n    \"fraud_outcome\": \"fraud\",\n    \"fraud_type\": \"third party fraud\",\n    \"fraud_subtype\": \"identity theft\",\n    \"label_source\": \"manual\",\n    \"conversion_flag\": \"declined\",\n    \"delinquency_bucket\": \"18\",\n    \"loss_amount_number\": \"596.23\",\n    \"loss_amount_currency\": \"USD\",\n    \"channel\": \"mobile\"\n  }\n}'","correspondingExample":"row12"},{"language":"shell","name":"13. Watchlist incomplete (fails)","code":"curl --request POST \\\n  --url https://riskos.socure.com/api/outcome_contribution \\\n  --header 'Authorization: Bearer <RISKOS_API_KEY>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"event_timestamp\": \"2024-01-15T10:30:00Z\",\n  \"eval_id\": \"c9b1dab6-4ffd-49f4-ba02-c5f517ef00fb\",\n  \"customer_user_id\": \"customer_123\",\n  \"notes\": \"Post-review fraud confirmation\",\n  \"tags\": [\n    \"manual-review\"\n  ],\n  \"watchlist\": {\n    \"reference_id\": \"10c50ad1-8aba-42b4-ab56-8f9ad582777b\",\n    \"decision\": \"maybe\",\n    \"notes\": \"Analyst review pending\",\n    \"additional_fields\": {\n      \"review_queue\": \"fraud-ops\"\n    }\n  }\n}'","correspondingExample":"row13"}]}}},"/api/reason-codes":{"get":{"tags":["Reason Codes"],"summary":"Retrieve the Reason Code Catalog","operationId":"getReasonCodes","security":[{"BearerAuth":[]}],"description":"Returns the catalog of reason codes available to your account, including each code's name, provider, description, and product. Use this endpoint to cache reason code descriptions in your own systems or to keep an internal mapping in sync, rather than reading the **Reason Codes** page in the RiskOS™ Dashboard manually.\n\nBy default, the response includes every active reason code and excludes deprecated codes. Use the query parameters to filter the catalog. You can combine parameters, and you can repeat `product` and `name` to match several values.\n\nThe catalog changes infrequently. Cache the response and refresh it periodically rather than calling the endpoint on every transaction.\n","parameters":[{"name":"product","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Account Intelligence","Address Risk","Deceased Check","Device Risk","Email Risk","Global Watchlist Screening","Phone Risk","Predictive DocV","Sigma First-Party Fraud","Sigma Identity Fraud","Sigma Synthetic","Socure Verify (KYC)"]}},"example":["Email Risk"],"description":"Returns only codes for the named product. Repeat the parameter to match several products.\n"},{"name":"name","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}},"description":"Returns only the codes whose name exactly matches the value. Repeat the parameter to request several codes.\n"},{"name":"text","in":"query","required":false,"schema":{"type":"string"},"description":"Returns codes whose name or description contains the substring, case-insensitive. Useful for keyword search.\n"},{"name":"isActive","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only active codes, or `false` to include deprecated codes. When omitted, only active codes are returned.\n"}],"responses":{"200":{"description":"The reason code catalog was retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"reasonCodes":{"type":"array","description":"The list of reason codes that match the request.","items":{"type":"object","properties":{"name":{"type":"string","description":"The reason code identifier."},"provider":{"type":"string","description":"The provider that produces the code."},"description":{"type":"string","description":"Human-readable explanation of the signal."},"product":{"type":"string","description":"The product the code belongs to. Omitted when the code is not product-specific.\n"},"isActive":{"type":"boolean","description":"Whether the code is currently in use."},"releaseDate":{"type":"string","format":"date","description":"The date the code was released (`YYYY-MM-DD`), when available.\n"},"deprecatedDate":{"type":"string","format":"date","description":"The date the code was deprecated (`YYYY-MM-DD`), when applicable.\n"},"additionalNote":{"type":"string","description":"Supplementary guidance for the code, when available."}}}}}},"examples":{"catalogExample":{"summary":"Example Response","value":{"reasonCodes":[{"name":"RXXXX","provider":"Socure","description":"Description of a risk signal.","product":"Email Risk","isActive":true,"releaseDate":"2024-03-15"},{"name":"IXXXX","provider":"Socure","description":"Description of an informational signal.","product":"Address Risk","isActive":true}]}}}}}},"401":{"description":"Unauthorized - The API key is missing or invalid."},"500":{"description":"Internal Server Error - RiskOS™ could not retrieve the catalog. Retry, then contact Socure support if the problem persists.\n"}}}},"/api/custom-watchlists/{listId}/records":{"post":{"tags":["Custom Watchlist"],"summary":"Manage a Custom Watchlist Record","operationId":"ingestCustomWatchlistRecord","security":[{"BearerAuth":[]}],"description":"Add, update, or soft-delete a record in a custom watchlist. The operation is determined by the `action_type` field:\n\n- **add**: Create a new record in the watchlist.\n- **update**: Update an existing record.\n- **delete**: Soft-delete a record. The record stays on the list, but its status changes from Active to Inactive.\n\nAll operations are keyed by `record.id`. The list itself must already exist — create it in the RiskOS™ Dashboard before calling this endpoint.\n","parameters":[{"name":"listId","in":"path","required":true,"description":"The unique ID of the custom watchlist to add, update, or remove a record from. The list must already exist (created in the RiskOS™ Dashboard).\n","schema":{"type":"string","format":"uuid"},"example":"e22139a9-c6bb-46f4-b284-7a665f282cd0"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action_type","record"],"properties":{"action_type":{"type":"string","enum":["add","update","delete"],"description":"The action to take on this record — `add`, `update`, or `delete`.\nNote: `delete` is a soft delete; the record stays on the list, but its status changes from Active to Inactive.\n","example":"add"},"record":{"type":"object","description":"The record details you're adding, updating, or deleting.\n","required":["id"],"properties":{"id":{"type":"string","maxLength":128,"description":"A unique ID you assign to this record, used for all future updates or deletions. Must be unique within the watchlist. Maximum length is 128 characters.\n","example":"rec-0000002"},"entity_name":{"type":"string","description":"The full name of the individual or organization on the watchlist. Required when adding or updating a record.\n","example":"John Doe"},"entity_type":{"type":"string","enum":["individual","organisation","vessel","aircraft","others"],"description":"Whether this record represents a person (`individual`), a business or group (`organisation`), a `vessel`, an `aircraft`, or `others`.\n","example":"individual"},"list_origin":{"type":"string","description":"A label describing where this record came from — an internal team or an external source (for example, \"EXTERNAL LIST\") — to help track how it entered the watchlist.\n","example":"EXTERNAL LIST"},"title":{"type":"string","description":"The individual's job title or role, if relevant (for example, \"Analyst\" or \"Director\").","example":"Analyst"},"official_list_id":{"type":"string","description":"An external reference ID for this record from another list or system outside RiskOS™ (for example, a vendor's sanctions-list ID). Separate from `id`, which applies only within this watchlist.\n","example":"test"},"listed_date":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date this record was first listed, in YYYY-MM-DD format.","example":"2025-01-01"},"akas":{"type":"array","items":{"type":"string"},"description":"Any known aliases or alternate names for this individual or organization.","example":["Johnny Doe","John Doee"]},"date_of_birth":{"type":"array","items":{"type":"string","format":"date","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"description":"One or more known dates of birth, in YYYY-MM-DD format. Provide more than one if sources disagree.\n","example":["1990-01-01"]},"address":{"type":"object","description":"The individual's or organization's address.","properties":{"line_1":{"type":"string","description":"Street number or house name and street name.","example":"1 Main St"},"line_2":{"type":"string","description":"Additional street address, like landmarks.","example":"Apt 2"},"locality":{"type":"string","description":"City, town, or village.","example":"New York"},"major_admin_division":{"type":"string","description":"Major administrative division like the state, province, or oblast.","example":"NY"},"minor_admin_division":{"type":"string","description":"Minor administrative division like the city area or district.","example":"Manhattan"},"country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Country in ISO 3166-1 alpha-2 format. For example: US, CA.","example":"US"},"postal_code":{"type":"string","description":"The postal or ZIP code.","example":"10001"}}},"national_ids":{"type":"array","items":{"type":"string"},"description":"Government-issued ID numbers for this individual or organization (for example, a Social Security Number or National Insurance Number).\n","example":["123-45-6789"]},"nationality":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"The individual's nationality or nationalities, as 2-letter country codes (for example, US).","example":["US"]},"country_of_birth":{"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$"},"description":"The country or countries where this individual was born, as 2-letter country codes (for example, US).","example":["US"]},"place_of_birth":{"type":"array","items":{"type":"string"},"description":"The city or place(s) where this individual was born.","example":["New York"]},"phone_numbers":{"type":"array","items":{"type":"string"},"description":"Phone number(s) for this individual or organization, in E.164 format including country code (for example, +12125550123).\n","example":["+12125550123"]},"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"Email address(es) associated with this individual or organization.","example":["john@example.com"]},"occupation":{"type":"array","items":{"type":"string"},"description":"The individual's occupation or profession(s), if known.","example":["Engineer"]},"gender":{"type":"string","enum":["male","female","other"],"description":"The individual's gender.","example":"male"},"account_numbers":{"type":"array","items":{"type":"string"},"description":"Bank account number(s) associated with this individual or organization.","example":["ACC-001"]},"crypto_addresses":{"type":"array","items":{"type":"string"},"description":"Cryptocurrency wallet address(es) associated with this individual or organization.","example":["0xabc123"]},"notes":{"type":"string","description":"Free-text notes about this record, such as why it was added.","example":"flagged for review"}}}}},"examples":{"addRecord":{"summary":"Add a new record","value":{"action_type":"add","record":{"id":"rec-0000002","entity_name":"John Doe","entity_type":"individual","list_origin":"EXTERNAL LIST","title":"Analyst","official_list_id":"test","listed_date":"2025-01-01","akas":["Johnny Doe","John Doee"],"date_of_birth":["1990-01-01"],"address":{"line_1":"1 Main St","line_2":"Apt 2","locality":"New York","major_admin_division":"NY","minor_admin_division":"Manhattan","country":"US","postal_code":"10001"},"national_ids":["123-45-6789"],"nationality":["US"],"country_of_birth":["US"],"place_of_birth":["New York"],"phone_numbers":["+12125550123"],"emails":["john@example.com"],"occupation":["Engineer"],"gender":"male","account_numbers":["ACC-001"],"crypto_addresses":["0xabc123"],"notes":"flagged for review"}}},"updateRecord":{"summary":"Update an existing record","value":{"action_type":"update","record":{"id":"rec-0000002","entity_name":"John Doe","entity_type":"individual","address":{"line_1":"1 Main St","line_2":"Apt 2","locality":"New York City","major_admin_division":"NY","minor_admin_division":"Manhattan","country":"US","postal_code":"10001"},"notes":"updated address"}}},"deleteRecord":{"summary":"Soft-delete a record","value":{"action_type":"delete","record":{"id":"rec-0000002"}}}}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the request succeeded. A successful HTTP response alone doesn't guarantee the record was added, updated, or deleted — always check this field.\n","example":true},"record_id":{"type":"string","description":"The ID of the record that was processed. Returned only when the request succeeds.","example":"rec-0000002"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CustomWatchlistErrorItem"},"description":"A list of reasons the request failed. Present only when `success` is false."}}},"examples":{"success":{"summary":"Successful response","value":{"success":true,"record_id":"rec-0000002"}}}}}},"400":{"description":"Bad Request — validation error or upstream rejection.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CustomWatchlistErrorItem"}}}},"examples":{"validationError":{"summary":"Missing required field","value":{"success":false,"errors":[{"field":"action_type","code":"REQUIRED","message":"action_type is required"}]}},"invalidActionType":{"summary":"Invalid action type","value":{"success":false,"errors":[{"field":"action_type","code":"INVALID","message":"invalid action_type — must be add, update, or delete"}]}},"missingEntityName":{"summary":"Missing entity name","value":{"success":false,"errors":[{"field":"record.entity_name","code":"REQUIRED","message":"record.entity_name is required"}]}},"invalidGender":{"summary":"Invalid enum value","value":{"success":false,"errors":[{"field":"record.gender","code":"INVALID","message":"invalid gender — must be male, female, or other"}]}}}}}},"401":{"description":"Unauthorized — invalid or missing authentication token.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CustomWatchlistErrorItem"}}}},"example":{"success":false,"errors":[{"code":"UNAUTHORIZED","message":"authentication failed"}]}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CustomWatchlistErrorItem"}}}},"example":{"success":false,"errors":[{"code":"INTERNAL_ERROR","message":"failed to resolve account context"}]}}}},"502":{"description":"Bad Gateway — upstream service error.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"errors":{"type":"array","items":{"$ref":"#/components/schemas/CustomWatchlistErrorItem"}}}},"example":{"success":false,"errors":[{"code":"UPSTREAM_ERROR","message":"upstream service unavailable"}]}}}}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Socure provides separate RiskOS™ keys for the Sandbox and Production environments. Be sure to use the correct key when making a request.\n"}},"schemas":{"OutcomeError":{"type":"object","description":"Application error envelope returned by the Evaluation Outcome API for validation and server errors.","required":["status","code","message"],"properties":{"status":{"type":"string","description":"Always `error` for an error response.","example":"error"},"code":{"type":"string","description":"Machine-readable error code.","enum":["EMPTY_BODY","INVALID_JSON","CONTRACT_VALIDATION_FAILED","UNKNOWN_CONTRACT_VERSION","PAYLOAD_TOO_LARGE","INTERNAL_ERROR"],"example":"CONTRACT_VALIDATION_FAILED"},"message":{"type":"string","description":"Human-readable detail. For `CONTRACT_VALIDATION_FAILED`, a multi-line list of every failing field.","example":"validation error:\n - event_timestamp: is required"}},"example":{"status":"error","code":"CONTRACT_VALIDATION_FAILED","message":"validation error:\n - event_timestamp: is required"}},"CustomerMetadata":{"title":"Customer Metadata","type":"object","nullable":true,"additionalProperties":true,"description":"Optional, opaque JSON object echoed back unchanged on the response and at the top level of webhook callbacks — use it to route and correlate requests. Must be a JSON object of up to 200 characters total (the entire serialized JSON); larger payloads return `413 CUSTOMER_METADATA_TOO_LARGE`. Omit it or send `null` to skip. Don't include PII or secrets. See [Customer Metadata](https://help.socure.com/riskos/docs/customer-metadata).","example":{"service":"checkout-api","business_unit":"consumer-lending","internal_ref":"order-998877"}},"Address":{"type":"object","properties":{"line_1":{"type":"string","description":"Street number or house name and street name","example":"200 Key Square St"},"line_2":{"type":"string","description":"Additional street address, like landmarks","example":""},"locality":{"type":"string","description":"City, town or village","example":"New York City"},"minor_admin_division":{"type":"string","description":"Minor administrative division like the city area or district","example":""},"major_admin_division":{"type":"string","description":"Major administrative division like the state, province, or oblast","example":"NY"},"country":{"type":"string","description":"Country in ISO 3166-1 alpha-2 format. Ex: 'US', 'CA'","example":"US"},"postal_code":{"type":"string","description":"The postal or ZIP code","example":"12345"},"type":{"type":"string","example":"HOME","description":"The type of the address like Home, Office"}}},"Inquiries":{"description":"The inquiry type. Below are the possible values.\n- `AVAILABILITY`: Used to confirm a bank account's availability.\n- `OWNERSHIP`: Used to verify a bank account's ownership.\n","type":"array","items":{"type":"string","enum":["AVAILABILITY","OWNERSHIP"]},"example":["AVAILABILITY","OWNERSHIP"]},"Amount":{"type":"object","description":"Represents a monetary amount with its associated currency.","properties":{"amount":{"type":"number","format":"double","description":"The monetary value, represented as a numeric value.","example":120000},"currency":{"type":"string","description":"The currency code in ISO 4217 format (e.g., USD for US dollars).","example":"USD"}}},"AccountView":{"type":"object","description":"A read-only snapshot of the account’s balances and recent activity.","properties":{"available_balance":{"$ref":"#/components/schemas/Amount"},"current_balance":{"$ref":"#/components/schemas/Amount"},"last_activity_at":{"type":"string","format":"date-time","example":"2022-03-21T21:50:07.623Z"}}},"AccountSnapshot":{"type":"object","description":"Represents a snapshot of the account’s state at a specific point in time.","properties":{"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"account_view":{"$ref":"#/components/schemas/AccountView"}}},"Account":{"type":"object","description":"Defines the schema of an bank account.","properties":{"type":{"type":"string","enum":["CHECKING","SAVINGS"],"example":"CHECKING","description":"Account Type"},"account_type":{"type":"string","enum":["PERSONAL","BUSINESS"],"example":"PERSONAL","description":"Account holder type. Required for international Account Intelligence requests."},"account_number":{"type":"string","example":"4111111111111111","description":"Bank account number"},"routing_number":{"type":"string","example":"1283673312","description":"Routing number associated with the account"},"swift_bic":{"description":"Swift/BIC Code of the account","type":"string","example":"CH-123"},"opened_at":{"description":"ISO 8601/ RFC 3339 date-time. Date the account was opened.","type":"string","format":"date-time","example":"2022-05-26T05:02:09.985Z"},"institution_name":{"description":"Name of the institution (e.g. XYZ bank)","type":"string","example":"Chase"},"id":{"type":"string","maxLength":255,"example":"78456158930","description":"Client provided unique Account ID.\n"},"institution_address":{"$ref":"#/components/schemas/Address"},"account_inquiries":{"$ref":"#/components/schemas/Inquiries"},"account_snapshot":{"$ref":"#/components/schemas/AccountSnapshot"},"custom":{"type":"object","description":"Send any additional, customer-specific data in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information.","example":{"key1":"stringValue","key2":true,"key3":100,"key4":{"customObjKey1":200}},"additionalProperties":{}}}},"DocumentVerificationConfig":{"type":"object","description":"The configurations for the document request transaction.","properties":{"send_message":{"type":"boolean","description":"Set to `true` (boolean) to enable the SMS text message containing the document request URL. This field is set to `false` by default.\n> **Note:** SMS behavior varies by region:\n> - **US & Canada**: Messages are sent from our approved short code `33436`.\n> - **All other countries**: Messages are sent from our long code `+15103301986`.\n","example":false},"language":{"type":"string","description":"Specifies the language package for the Capture App. Below are the possible values.\n- Automatic (device default): `auto`\n- Arabic: `ar`\n- Arabic (Saudi Arabia): `ar-sa`\n- Armenian: `hy`\n- Bengali: `bn`\n- Chinese (Hong Kong): `zh-hk`\n- Chinese (Simplified): `zh-cn`\n- Chinese (Traditional): `zh-tw`\n- Czech: `cs-cz`\n- Danish: `da-dk`\n- Dutch: `nl-nl`\n- English: `en`\n- English (Australian): `en-au`\n- English (Canadian): `en-ca`\n- English (United Kingdom): `en-gb`\n- English (United States): `en-us`\n- Finnish: `fi-fi`\n- French: `fr`\n- French (Canada): `fr-ca`\n- German: `de-de`\n- Haitian Creole: `ht`\n- Hebrew: `he-il`\n- Hindi: `hi-in`\n- Hungarian: `hu-hu`\n- Indonesian: `id-id`\n- Italian: `it`\n- Italian (Switzerland): `it-ch`\n- Japanese: `ja-jp`\n- Korean: `ko`\n- Malay: `ms-my`\n- Norwegian: `no-no`\n- Polish: `pl-pl`\n- Portuguese (Brazil): `pt-br`\n- Portuguese (Portugal): `pt-pt`\n- Romanian (Moldova): `ro-mo`\n- Romanian (Romania): `ro-ro`\n- Russian: `ru`\n- Slovak: `sk-sk`\n- Spanish: `es`\n- Spanish (Argentina): `es-ar`\n- Spanish (International): `es-001`\n- Spanish (Mexico): `es-mx`\n- Spanish (Spain): `es-es`\n- Spanish (US): `es-us`\n- Swedish: `sv-se`\n- Tagalog: `tl`\n- Thai: `th-th`\n- Turkish: `tr-tr`\n- Urdu: `ur`\n- Vietnamese: `vi`\nSet `language` to `auto` to use the consumer's device default language. If the device's default language isn't supported, the Capture App defaults to English (`en`).\n","example":"en-us","default":"en-us","enum":["auto","ar","ar-sa","bn","cs-cz","da-dk","de-de","en","en-au","en-ca","en-gb","en-us","es","es-001","es-ar","es-es","es-mx","es-us","fi-fi","fr","fr-ca","he-il","hi-in","ht","hu-hu","hy","id-id","it","it-ch","ja-jp","ko","ms-my","nl-nl","no-no","pl-pl","pt-br","pt-pt","ro-mo","ro-ro","ru","sk-sk","sv-se","th-th","tl","tr-tr","ur","vi","zh-cn","zh-hk","zh-tw"]},"use_case_key":{"type":"string","description":"The name of the flow (created in RiskOS™) to use with this transaction.\n> **Note**: If the value is incorrect or not provided, the transaction uses the flow marked as **Default** in RiskOS™.\n","example":"flow_1"},"redirect":{"type":"object","description":"Optional URL settings that redirect the consumer after the document capture and upload process is cancelled or completed on the Capture App.","properties":{"url":{"type":"string","description":"Specifies the redirect destination URL.\n> **Note**: This field is required if `redirect` is provided.\n","example":"https://www.example.com"},"method":{"type":"string","description":"The redirect method.\n> **Note**: This field is required if `redirect` is provided.\n","example":"GET","default":"POST","enum":["GET","POST"]},"headers":{"type":"object","description":"Specifies an optional object where you can define custom headers.\n","example":{}},"delay":{"type":"number","description":"Adds a delay before redirecting, specified in milliseconds.\n","example":3000}}},"document_type":{"type":"string","description":"Enables a simplified Capture App flow and allows you to select a default document type for the transaction using one of the values below.\n- `license`: Driver's license\n- `passport`: Passport\n\n> **Note**: Passing `documentType` with the value `license`  or `passport` implements a simplified Capture App flow that skips the Selected ID Type Screen and starts the flow on the Document Capture Screen.\n","example":"license"}}},"Docv":{"type":"object","properties":{"transaction_token":{"type":"string","description":"The transaction token from the Document Request API response (v5). Use this if integrated with Socure's DocV solution.\n","example":"1558769a-f069-48b1-b273-bd885dae1383"},"barcode_payload":{"type":"string","description":"The barcode payload read from the back of an identity document, provided as a base64-encoded string (typically 300–500 bytes). Send this to verify a barcode in a single Evaluation request, instead of uploading it separately with the Upload API. Do not send image data in this field.\n","example":"<base64-encoded barcode payload>"},"config":{"$ref":"#/components/schemas/DocumentVerificationConfig"}}},"Otp":{"type":"object","description":"Contains the OTP data for the transaction.\n","properties":{"code":{"type":"string","description":"The one-time passcode.","example":""},"resend":{"type":"boolean","description":"Set to `true` to trigger a resend of the OTP.","example":false}}},"UserConsent":{"type":"boolean","description":"Indicates if the consumer has provided consent. This field must be set to `true` in order for the transaction to be processed; otherwise a 400 error will be returned.\n> **Note**: A `null` value can be passed in the field to skip the eCBSV module and still process the transaction with the other modules included in the request.\n","example":true},"ConsentTimestamp":{"type":"string","format":"date-time","description":"The date and time when the user provided consent, specified in ISO 8601 format. If no value is provided, defaults to the current timestamp of the evaluation.\n> **Note**: Although the `consentTimestamp` parameter is optional, it's crucial to provide it when using the `ecbsv` module to meet the 90-day consent window set by the SSA for compliance with the eCBSV service.\n","example":"2020-09-13T23:11:12.000Z"},"PreviousReferenceID":{"type":"string","maxLength":36,"description":"The `referenceId` of a previous Socure transaction. Allows you to link multiple transactions together. ","example":"e9c170f2-b3e4-423b-a373-5d6e1e9b23f8"},"UserName":{"type":"string","description":"The username associated with a consumer's account.","example":"johnsmith1979"},"DriverLicense":{"type":"string","description":"The driver's license identification number.","example":"000000000"},"DriverLicenseState":{"type":"string","description":"The two letter postal code of the issuing state.","example":"NY"},"AdditionalContext":{"type":"object","description":"Use this field to pass additional data required by specific Socure products. Additional fields are typically optional and should only be used if explicitly stated in the product documentation.","properties":{"user_consent":{"$ref":"#/components/schemas/UserConsent"},"consent_timestamp":{"$ref":"#/components/schemas/ConsentTimestamp"},"previous_reference_id":{"$ref":"#/components/schemas/PreviousReferenceID"},"user_name":{"$ref":"#/components/schemas/UserName"},"disclosure_purpose":{"type":"string","enum":["GLBA_502(e)"],"description":"This field must be set to `GLBA_502(e)` to support acceptable use of the product. Data contributed to Sigma First-Party Fraud is Non-Public Information (NPI) that may only be further disclosed pursuant to the GLBA fraud exception.\n","example":"GLBA_502(e)","maxLength":255},"entity_type":{"type":"string","description":"The entity type. Possible values are `Individual`, `Organization`, `Vessel`, `Aircraft`, `Others`."},"entity_name":{"type":"string","description":"The entity's full name. Must not contain special characters."},"accept_list":{"type":"boolean","description":"Set to `true` if the entity was accepted to conduct business with your organization. The default setting is `false`.\n"},"notes":{"type":"string","description":"Optional notes that capture details about known risks when conducting business with the entity. Only use this field if the `accept_list` is set to `true`.\n","example":"Was reviewed and identified to be a false positive. Risk was accepted"},"driver_license":{"$ref":"#/components/schemas/DriverLicense"},"driver_license_state":{"$ref":"#/components/schemas/DriverLicenseState"},"mno_status":{"type":"boolean","description":"Set to `true` to run Socure Phone Risk with Real-Time SIM Swap Verification. When enabled, the Phone Risk response returns additional SIM Swap reason codes. Requires the Phone Risk with SIM Swap enrichment to be configured in your workflow.\n","example":true}}},"Channel":{"type":"string","description":"Specifies the mode of interaction on the consumer's end.  <br /><br /> Available values include: `web`, `mobile`, `pos`, and `other`.\n","example":"mobile","enum":["web","mobile","pos","other"]},"LineOfBusiness":{"type":"string","maxLength":255,"description":"Optional free-form field that allows to pass on the line of business the request originates from.\n","example":"..."},"IPAddress":{"type":"string","description":"The consumer's IP address in IPv4 decimal or IPv6 hexadecimal format.\n","example":"1.2.3.4"},"Device":{"type":"object","description":"Use this field to provide external device data, e.g. originating from a third party data intelligence provider.","properties":{"id":{"type":"string","description":"Unique customer side identifier for device.","example":"9876543"},"session":{"type":"string","description":"Unique customer side identifier for device session.","example":"567h89e293r8h3"},"fingerprint":{"type":"string","description":"Unique customer side identifier for device fingerprint. This could be same as the `id`.","example":"9823rh23hr9r23"},"fingerprint_provider":{"type":"string","description":"Name of the fingerprint provider used to generate the fingerprint and/or id.","example":"internal"},"user_agent":{"type":"string","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.85 Safari/537.36"},"device_type":{"type":"string","example":"Mobile"},"is_known":{"type":"boolean","example":false},"first_seen_time":{"type":"string","format":"date-time","description":"RFC 3339 date-time string","example":"2022-07-28T06:10:54.298Z"},"last_seen_time":{"type":"string","format":"date-time","description":"RFC 3339 date-time string","example":"2022-07-28T06:10:54.298Z"},"timezone_mismatch":{"type":"boolean","example":true},"ip_address":{"type":"string","example":"127.0.0.1"},"is_ip_bad_proxy":{"type":"boolean","example":false},"is_ip_proxy":{"type":"boolean","example":false},"ip_risk_score":{"type":"number","format":"float","description":"A numeric score indicating the risk level associated with the IP address. Higher values indicate greater risk. This score is derived from the IP enrichment provider. Use alongside `is_ip_proxy` and `is_ip_bad_proxy` for a comprehensive IP risk assessment.","example":52.5},"ip_isp":{"type":"string","example":"XYZ Communications"},"ip_country_code":{"type":"string","example":"US"},"ip_city":{"type":"string","example":"New York"},"ip_region":{"type":"string","example":"NY"},"is_ip_tor":{"type":"boolean","example":false},"is_emulator":{"type":"boolean","example":false},"custom":{"type":"object","description":"Send any additional, customer-specific data in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information.","example":{"key1":"stringValue","key2":true,"key3":100,"key4":{"customObjKey1":200}},"additionalProperties":{}}}},"ConsumerOnboarding":{"title":"Consumer Onboarding","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","example":"consumer_onboarding","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"onb-12345"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Consumer Onboarding workflow.","properties":{"individual":{"type":"object","description":"Represents core information about the primary consumer.","properties":{"id":{"type":"string","description":"A unique identifier for a consumer provided by the customer, used across various use cases.","example":"9876543"},"given_name":{"type":"string","description":"The consumer's given name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Dwayne","maxLength":240},"family_name":{"type":"string","description":"The consumer's family name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Denver","maxLength":240},"suffix":{"type":"string","description":"A suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).","example":"JR."},"national_id":{"type":"string","description":"The consumer's national identification number. For US consumer's, this can be a nine-digit Social Security Number (SSN) or Individual Tax Identification Number (ITIN). Partial SSNs (last four digits) are also accepted. Hyphens are optional.\n","example":"461118208"},"date_of_birth":{"type":"string","format":"date","description":"The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC 3339.","example":"1975-04-02"},"email":{"type":"string","description":"The consumer's email address.","example":"john.doe@example.com"},"alternate_email":{"type":"string","description":"The consumer's alternate email address.","example":"doe.john@example.com"},"phone_number":{"type":"string","description":"The consumer’s phone number. The API expects the standard E.164 format (e.g., +12025550147) but tolerates hyphens and spaces for user convenience.\n\n**Examples:**\n- United States: `+13475550100`\n- United Kingdom: `+447911123456`\n- Brazil: `+5511987654321`\n- India: `+919876543210`\n- Australia: `+61412345678`\n","example":"+1-202-555-0147"},"alternate_phone_number":{"type":"string","description":"The consumer’s phone number in E.164 format, which includes the country code (e.g., `+` followed by international dialing code and number). The API expects the standard E.164 format but tolerates hyphens and spaces for user convenience. \n","example":"+1-555-202-0147"},"gender":{"type":"string","enum":["Male","Female","Self Identify"],"description":"The consumer's gender.\n","example":"Male"},"address":{"$ref":"#/components/schemas/Address"},"account":{"$ref":"#/components/schemas/Account"},"docv":{"$ref":"#/components/schemas/Docv"},"otp":{"$ref":"#/components/schemas/Otp"},"additional_context":{"$ref":"#/components/schemas/AdditionalContext"},"di_session_token":{"type":"string","description":"Token required to extract Device Intelligence (DI) signals.","example":"SESSION-ABC123"},"custom":{"type":"object","additionalProperties":true,"description":"Send any additional, customer-specific data for this consumer in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}},"additional_individuals":{"description":"Include details of additional consumers if the evaluation involves multiple people. This field allows you to expand the evaluation scope beyond the primary consumer.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for an consumer provided by the customer, used across various use cases.","example":"9876543"},"given_name":{"type":"string","description":"The consumer's given name.","example":"Dwayne","maxLength":240},"family_name":{"type":"string","description":"The consumer's family name.","example":"Denver","maxLength":240},"suffix":{"type":"string","description":"A suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).","example":"JR."},"national_id":{"type":"string","description":"The consumer's national identification number. For US consumer, this can be a nine-digit Social Security Number (SSN) or Individual Tax Identification Number (ITIN). Partial SSNs (last four digits) are also accepted. Hyphens are optional.\n","example":"461118208"},"date_of_birth":{"type":"string","format":"date","description":"The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC 3339.","example":"1975-04-02"},"email":{"type":"string","description":"The consumer's email address.","example":"john.doe@example.com"},"alternate_email":{"type":"string","description":"The consumer's alternate email address.","example":"doe.john@example.com"},"phone_number":{"type":"string","description":"The consumer’s phone number. The API accepts E.164 format (e.g., `+12025550147`) but tolerates hyphens and spaces for user convenience.\nExample formats:\n- United States: `+13475550100`\n- United Kingdom: `+447911123456`\n- Brazil: `+5511987654321`\n- India: `+919876543210`\n- Australia: `+61412345678`\n","example":"+1-202-555-0147"},"alternate_phone_number":{"type":"string","description":"The consumer’s alternate phone number. The API accepts E.164 format (e.g., `+12025550147`) but tolerates hyphens and spaces for user convenience.\n","example":"+1-555-202-0147"},"gender":{"type":"string","enum":["Male","Female","Self Identify"],"description":"The consumer's gender.\n","example":"Male"},"address":{"$ref":"#/components/schemas/Address"},"account":{"$ref":"#/components/schemas/Account"},"docv":{"$ref":"#/components/schemas/Docv"},"additional_context":{"$ref":"#/components/schemas/AdditionalContext"},"di_session_token":{"type":"string","description":"Token required to extract Device Intelligence (DI) signals.","example":"SESSION-ABC123"},"custom":{"type":"object","additionalProperties":true,"description":"Send any additional, customer-specific data for this consumer in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}}},"channel":{"$ref":"#/components/schemas/Channel"},"line_of_business":{"$ref":"#/components/schemas/LineOfBusiness"},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"custom":{"type":"object","additionalProperties":true,"description":"Use this field to send any additional, customer-specific data relevant to the evaluation. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}}}},"AdvancedPrefill":{"title":"Advanced Prefill","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","example":"advanced_pre_fill","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. Use the identifier for your Advanced Prefill workflow (for example, `advanced_pre_fill`). <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"advanced-prefill-03f1de"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2026-04-02T12:00:00Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Advanced Prefill workflow.","properties":{"individual":{"type":"object","description":"Minimal identity and device inputs used to verify the requester and gate identity-data disclosure. Only `phone_number` and `di_session_token` are required; additional attributes improve Prefill match accuracy.","required":["phone_number","di_session_token"],"properties":{"di_session_token":{"type":"string","description":"Token from the Digital Intelligence SDK that links the device session. Generate it client-side before submitting the evaluation. Required to produce device risk signals for the data disclosure gate.","example":"YOUR_DI_SESSION_TOKEN"},"phone_number":{"type":"string","description":"The consumer's phone number. The API expects the standard E.164 format (e.g., +12025550147) but tolerates hyphens and spaces for user convenience.\n\n**Examples:**\n- United States: `+13475550100`\n- United Kingdom: `+447911123456`\n- Brazil: `+5511987654321`\n- India: `+919876543210`\n- Australia: `+61412345678`\n","example":16673681976},"date_of_birth":{"type":"string","format":"date","description":"The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC 3339. Recommended to improve Prefill match accuracy.","example":"1992-03-11"},"national_id":{"type":"string","description":"The consumer's national identification number. For US consumers, this can be a nine-digit Social Security Number (SSN) or Individual Tax Identification Number (ITIN). Partial SSNs (last four digits) are also accepted. Hyphens are optional. Recommended to improve Prefill match accuracy.\n","example":"555667772"},"given_name":{"type":"string","description":"The consumer's given name. Recommended to improve Prefill match accuracy.","example":"Franky","maxLength":240},"family_name":{"type":"string","description":"The consumer's family name. Recommended to improve Prefill match accuracy.","example":"Valley","maxLength":240},"email":{"type":"string","description":"The consumer's email address. May improve deny list screening.","example":"frankeyV@test.com"},"id":{"type":"string","description":"A customer-defined identifier for the consumer that maps to `userId` in enrichments or internal systems.","example":"username"},"address":{"$ref":"#/components/schemas/Address"},"otp":{"$ref":"#/components/schemas/Otp"}}},"channel":{"$ref":"#/components/schemas/Channel"},"line_of_business":{"$ref":"#/components/schemas/LineOfBusiness"},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"custom":{"type":"object","additionalProperties":true,"description":"Use this field to send any additional, customer-specific data relevant to the evaluation. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information."}}}}},"Individual":{"type":"object","description":"Represents core information about the primary individual consumer.","properties":{"id":{"type":"string","description":"Maps to the `userId` in  enrichments or a customer’s internal identifier.  Can be enabled as a searchable field in RiskOS™ Dashboard.","example":"9876543"},"given_name":{"type":"string","description":"The consumer's given name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Dwayne","maxLength":240},"family_name":{"type":"string","description":"The consumer's family name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Denver","maxLength":240},"suffix":{"type":"string","description":"A suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).","example":"JR."},"national_id":{"type":"string","description":"The consumer's national identification number. For US consumers, this can be a nine-digit Social Security Number (SSN) or Individual Tax Identification Number (ITIN). Partial SSNs (last four digits) are also accepted. Hyphens are optional.\n","example":"461118208"},"date_of_birth":{"type":"string","format":"date","description":"The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC 3339.","example":"1975-04-02"},"email":{"type":"string","description":"The consumer's email address.","example":"john.doe@example.com"},"alternate_email":{"type":"string","description":"The consumer's alternate email address.","example":"doe.john@example.com"},"phone_number":{"type":"string","description":"The consumer’s phone number. The API expects the standard E.164 format (e.g., +12025550147) but tolerates hyphens and spaces for user convenience.\n\n**Examples:**\n- United States: `+13475550100`\n- United Kingdom: `+447911123456`\n- Brazil: `+5511987654321`\n- India: `+919876543210`\n- Australia: `+61412345678`\n","example":"+1-202-555-0147"},"alternate_phone_number":{"type":"string","description":"The consumer’s alternate phone number. The API accepts E.164 format (e.g., `+12025550147`) but tolerates hyphens and spaces for user convenience.\n","example":"+1-555-202-0147"},"gender":{"type":"string","enum":["Male","Female","Self Identify"],"description":"The consumer's gender.\n","example":"Male"},"address":{"$ref":"#/components/schemas/Address"},"account":{"$ref":"#/components/schemas/Account"},"docv":{"$ref":"#/components/schemas/Docv"},"additional_context":{"$ref":"#/components/schemas/AdditionalContext"},"di_session_token":{"type":"string","description":"Token required to extract Device Intelligence (DI) signals.","example":"SESSION-ABC123"},"custom":{"type":"object","additionalProperties":true,"description":"Send any additional, customer-specific data for this consumer in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}},"GenericPassthrough":{"title":"Generic Passthrough","type":"object","description":"Schema for a generic pass-through evaluation flow. Typically used when the goal is to retrieve Socure module data without applying a full risk evaluation.\n","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","example":"generic_passthrough","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"genr-12345"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Pass-Through workflow.","properties":{"individual":{"$ref":"#/components/schemas/Individual"},"modules":{"type":"array","description":"A list of Socure module names to include in the pass-through evaluation. Each entry is a module identifier string following the same naming convention as the ID+ endpoint modules — for example `[\"fraud\", \"synthetic\"]`. The module names you can request depend on the enrichments enabled for your workflow and your Socure contract:\n\n- `accountintelligence`\n- `accountintelligencepremier`\n- `addressrisk`\n- `deceasedcheck`\n- `devicerisk`\n- `digitalintelligence`\n- `documentverification`\n- `ecbsv`\n- `emailrisk`\n- `firstpartyfraud`\n- `fraud`\n- `graphintelligenceplus`\n- `graphintelligencestandard`\n- `kyc`\n- `kycplus`\n- `phonerisk`\n- `prefill`\n- `secondarydocument`\n- `selfieintelligence`\n- `selfiereverification`\n- `synthetic`\n- `watchlistplus`\n- `watchlistpremier`\n- `watchliststandard`\n\n**Note:** Listing a module in `data.modules` does not by itself guarantee a pass-through. The requested module data is returned only when your workflow is configured with a pass-through enrichment.","items":{"type":"string","example":"fraud"},"example":["fraud","synthetic"]},"channel":{"$ref":"#/components/schemas/Channel"},"line_of_business":{"$ref":"#/components/schemas/LineOfBusiness"},"ip_address":{"$ref":"#/components/schemas/IPAddress"}}}}},"TrustAndSafety":{"title":"Trust and Safety","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request.","example":"trust_and_safety"},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"TS-REQ-123456"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Trust and Safety workflow.","required":["event_type"],"properties":{"event_type":{"type":"string","description":"Specifies the specific event type being tracked for a user, such as `identity_verification`, `document_submission`, or `badge_request`.","example":"identity_verification"},"event_category":{"type":"string","description":"Represents the category of the event occurring on a user profile or account within the context of Trust and Safety verification processes.","enum":["verification","authentication","action","update"]},"individual":{"$ref":"#/components/schemas/Individual"},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"custom":{"type":"object","additionalProperties":true,"description":"Include any additional customer-specific data relevant to the Trust and Safety evaluation in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "},"channel":{"$ref":"#/components/schemas/Channel"}}}}},"BankAccountVerification":{"title":"Bank Account Verification","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request.","example":"bank_account_verification"},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"BAV-REQ-123456"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Bank Account Verification workflow.","properties":{"individual":{"$ref":"#/components/schemas/Individual"},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"event_category":{"type":"string","description":"Represents the category of the event occurring on a user profile or account within the context of Bank Account Verification processes.","enum":["verification","authentication","action","update"]},"event_type":{"type":"string","description":"Specifies the specific event type being tracked for a user, such as `account_verification`.","example":"account_verification"},"custom":{"type":"object","additionalProperties":true,"description":"Include any additional customer-specific data relevant to the Bank Account Verification in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "},"channel":{"$ref":"#/components/schemas/Channel"}}}}},"Formation":{"type":"object","required":["entity_type","registration_date","registration_state","registration_country"],"properties":{"entity_type":{"type":"string","description":"Legal structure of the business. Free-form string; no fixed set of values is enforced. For best business verification results, send a standard legal entity type such as `CORPORATION`, `LLC`, `SOLE_PROPRIETOR`, or `PARTNERSHIP`.","example":"LLC"},"registration_date":{"type":"string","format":"date","description":"YYYY-MM-DD RFC 3339 date string","example":"2022-07-28"},"registration_state":{"type":"string","description":"State of registration","example":"CA"},"registration_country":{"type":"string","description":"Country of registration","example":"US"}}},"BusinessOnboarding":{"title":"Business Onboarding","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request.","example":"business_onboarding"},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"BIZ-123456"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Business Onboarding workflow.","properties":{"individual":{"$ref":"#/components/schemas/Individual"},"additional_individuals":{"type":"array","description":"A list of other individual consumers associated with the business, such as beneficial owners or authorized signatories.","items":{"$ref":"#/components/schemas/Individual"}},"business":{"type":"object","description":"Information related to the business entity being evaluated.","properties":{"id":{"type":"string","description":"A unique identifier for the business entity.","example":"029659c7-733e-444b-9d19-7d119c035bc6"},"name":{"type":"string","description":"The registered legal name of the business.","example":"XYZ Inc."},"phone_number":{"type":"string","description":"The consumer’s phone number. The API expects the standard E.164 format (e.g., +12025550147) but tolerates hyphens and spaces for user convenience.\n\n**Examples:**\n- United States: `+13475550100`\n- United Kingdom: `+447911123456`\n- Brazil: `+5511987654321`\n- India: `+919876543210`\n- Australia: `+61412345678`\n","example":"+1-987-654-3210"},"address":{"$ref":"#/components/schemas/Address"},"formation":{"$ref":"#/components/schemas/Formation"},"ein":{"type":"string","description":"The Employer Identification Number (EIN) of the business.","example":"XX-1899918"},"additional_addresses":{"type":"array","description":"Additional addresses associated with the business, such as mailing or branch locations.","items":{"$ref":"#/components/schemas/Address"}},"website_url":{"type":"string","description":"The website URL of the business.","example":"https://effectiv.ai"},"last_fiscal_revenue":{"$ref":"#/components/schemas/Amount"},"account":{"$ref":"#/components/schemas/Account"},"custom":{"type":"object","description":"Use this field to send any additional, customer-specific data relevant to the business evaluation. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. ","example":{"key1":"stringValue","key2":true,"key3":100,"key4":{"customObjKey1":200}},"additionalProperties":{}}}},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"custom":{"type":"object","additionalProperties":true,"description":"Include any additional, customer-specific data in this field as needed for the evaluation. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "},"channel":{"$ref":"#/components/schemas/Channel"},"line_of_business":{"$ref":"#/components/schemas/LineOfBusiness"}}}}},"AccountTakeover":{"title":"Login and Authentication","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request.","example":"account_takeover"},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"ATO-REQ-123456"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Login and Authentication workflow.","required":["event_type"],"properties":{"event_category":{"type":"string","description":"Specifies the high-level category of the event occurring within a consumer profile or account. Use this field to indicate the general type of user interaction for risk evaluation purposes. <br />  <br /> Use the following guidance when selecting a value:\n- `authenticate`: Use for authentication-related events where a user is\n  proving identity or access, such as login, logout, or session\n  re-authentication.\n- `information`: Use for events where a user requests or views\n  information without modifying account data, such as requesting a bank\n  statement, viewing account balances, or retrieving transaction history.\n- `update`: Use for events where a user updates or modifies account or\n  profile data, such as changing a password, updating an address, or\n  modifying contact information.\n- `action`: Use for all other user-initiated actions where a risk\n  evaluation is useful but the event does not fit into authentication,\n  information, or update categories.","enum":["authenticate","action","information","update"]},"event_type":{"type":"string","description":"A free-form, application-defined sub-category of the `event_category` that provides additional context about the specific event performed.  <br />  <br /> Examples include: `login`, `address_update`, `statement_download`, or `password_reset`.","example":"address_update"},"event_details":{"type":"object","description":"Contextual details about the specific event, such as previous and  updated state values.","properties":{"previous":{"type":"object","description":"Data reflecting the state prior to the update."},"updated":{"type":"object","description":"Data reflecting the new state after the update."}}},"individual":{"$ref":"#/components/schemas/Individual"},"channel":{"$ref":"#/components/schemas/Channel"},"line_of_business":{"$ref":"#/components/schemas/LineOfBusiness"},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"custom":{"type":"object","additionalProperties":true,"description":"Include any additional customer-specific data relevant to the Account Takeover evaluation in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}}}},"WorkforceVerification":{"title":"Workforce Verification","type":"object","required":["workflow","id","timestamp","data"],"properties":{"id":{"type":"string","format":"uuid","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"a86580cc-1733-4188-86b5-717166e1db8c"},"workflow":{"type":"string","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request.","example":"trust_and_safety"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"Event payload for the workforce verification application.","required":["event_type","event_category","individual"],"properties":{"event_type":{"type":"string","description":"Type of event being emitted.","enum":["application_submitted"],"example":"application_submitted"},"event_category":{"type":"string","description":"Category of the event.","enum":["workforce_verification"],"example":"workforce_verification"},"individual":{"type":"object","description":"Information about the individual being verified.","required":["id","given_name","family_name","email","phone_number","address","di_session_token"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the individual.","example":"09237776-f16b-4eec-9305-fc425843d887"},"given_name":{"type":"string","description":"The consumer's given name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"John","maxLength":240},"family_name":{"type":"string","description":"The consumer's family name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Smith","maxLength":240},"email":{"type":"string","format":"email","description":"Email address of the individual.","example":"john.smith@gmail.com"},"phone_number":{"type":"string","description":"Phone number for the individual. Not strictly E.164 to allow dashes and country codes.","example":"1-310-841-6189"},"address":{"type":"object","description":"Mailing address for the individual.","required":["line_1","locality","major_admin_division","country","postal_code"],"properties":{"line_1":{"type":"string","description":"Primary street address line.","example":"123 Main Street"},"locality":{"type":"string","description":"City, town, or locality.","example":"New York"},"major_admin_division":{"type":"string","description":"State or province code.","example":"NY"},"country":{"type":"string","description":"Country code in ISO 3166-1 alpha-2 format.","example":"US"},"postal_code":{"type":"string","description":"Postal or ZIP code.","example":"10001"}}},"di_session_token":{"type":"string","description":"Token required to extract Device Intelligence (DI) signals.","example":"eyJraWQiOiJmMzRiN2YiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.DI_LOW_SCORE"}}}}}}},"PaymentScreeningInstrument":{"type":"object","description":"Financial instrument details for Payment Screening.","properties":{"type":{"type":"string","enum":["BANK_ACCOUNT","CRYPTO_ADDRESS"],"description":"Financial instrument type.","example":"BANK_ACCOUNT"},"account":{"type":"object","description":"Bank account details. Required when `type` is `BANK_ACCOUNT`.","properties":{"id":{"type":"string","maxLength":255,"description":"Client-provided unique account identifier.","example":"78456158930"},"type":{"type":"string","enum":["CHECKING","SAVINGS"],"description":"Bank account type.","example":"CHECKING"},"account_number":{"type":"string","description":"Bank account number.","example":"12345678901"},"routing_number":{"type":"string","description":"Routing number associated with the account.","example":"122199983"},"swift_bic":{"type":"string","description":"SWIFT/BIC code.","example":"CHASUS33"},"iban":{"type":"string","description":"International Bank Account Number (IBAN).","example":"FR14 2004 1010 0505 0001 3M02 606"},"opened_at":{"type":"string","format":"date-time","description":"Date and time the account was opened, in ISO 8601 / RFC 3339 format.","example":"2022-05-26T05:02:09.985Z"},"institution_name":{"type":"string","description":"Financial institution name.","example":"Chase"},"account_inquiries":{"type":"array","description":"Inquiry types requested for the account.","items":{"type":"string","enum":["AVAILABILITY","OWNERSHIP"]},"example":["AVAILABILITY"]},"institution_address":{"$ref":"#/components/schemas/Address"},"account_snapshot":{"$ref":"#/components/schemas/AccountSnapshot"}}},"crypto_address":{"type":"object","description":"Crypto address details. Required when `type` is `CRYPTO_ADDRESS`.","properties":{"currency":{"type":"string","description":"Crypto asset code.","example":"XBT"},"network":{"type":"string","description":"Blockchain network name.","example":"bitcoin"},"address":{"type":"string","description":"Wallet address.","example":"18uKfaUjgG52rVeXEi3wxnveww7zZuECtE"}}}}},"PaymentScreeningIndividual":{"type":"object","description":"Individual party details for Payment Screening.","properties":{"id":{"type":"string","description":"Unique internal identifier for the consumer.","example":"src-ind-001"},"given_name":{"type":"string","maxLength":240,"description":"The consumer's given name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- Certain special characters are not supported\n","example":"Emily"},"family_name":{"type":"string","maxLength":240,"description":"The consumer's family name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- Certain special characters are not supported\n","example":"Chen"},"suffix":{"type":"string","description":"Suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).","example":"JR."},"national_id":{"type":"string","description":"The consumer's national identification number. For US consumers, this can be a nine-digit Social Security Number (SSN) or Individual Tax Identification Number (ITIN). Partial SSNs (last four digits) are also accepted. Hyphens are optional.\n","example":"123456789"},"date_of_birth":{"type":"string","format":"date","description":"Consumer date of birth in YYYY-MM-DD format.","example":"1988-04-12"},"email":{"type":"string","format":"email","description":"Consumer email address.","example":"jane.smith@example.com"},"alternate_email":{"type":"string","format":"email","description":"Consumer alternate email address.","example":"doe.john@example.com"},"phone_number":{"type":"string","description":"The consumer's phone number. The API expects the standard E.164 format (e.g., +12025550147) but tolerates hyphens and spaces for user convenience.\n\n**Examples:**\n- United States: `+13475550100`\n- United Kingdom: `+447911123456`\n- Brazil: `+5511987654321`\n- India: `+919876543210`\n- Australia: `+61412345678`\n","example":"+1-312-555-1234"},"alternate_phone_number":{"type":"string","description":"The consumer's alternate phone number in E.164 format. The API expects the standard E.164 format but tolerates hyphens and spaces for user convenience.\n","example":"+1-555-202-0147"},"gender":{"type":"string","enum":["Male","Female","Self Identify"],"description":"The consumer's gender.","example":"Female"},"address":{"$ref":"#/components/schemas/Address"},"instrument":{"$ref":"#/components/schemas/PaymentScreeningInstrument"},"additional_context":{"$ref":"#/components/schemas/AdditionalContext"},"di_session_token":{"type":"string","description":"Device intelligence session token.","example":"eyJ0eXAiOiJK..."}}},"PaymentScreeningBusiness":{"type":"object","description":"Business party details for Payment Screening.","properties":{"id":{"type":"string","description":"Unique identifier for the business entity.","example":"029659c7-733e-444b-9d19-7d119c035bc6"},"name":{"type":"string","description":"Legal business name. Recommended when party type is BUSINESS.","example":"Tech Innovators LLC"},"phone_number":{"type":"string","description":"Business phone number. E.164 is expected, but hyphens and spaces are tolerated.\n","example":"+1-800-555-6789"},"ein":{"type":"string","description":"Employer Identification Number (EIN) of the business.","example":"12-3456789"},"website_url":{"type":"string","format":"uri","description":"Business website URL.","example":"https://techinnovators.com"},"address":{"$ref":"#/components/schemas/Address"},"instrument":{"$ref":"#/components/schemas/PaymentScreeningInstrument"},"formation":{"type":"object","description":"Business formation details.","additionalProperties":true}}},"PaymentScreening":{"title":"Payment Screening","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","example":"payment_screening","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"txn-007341829056"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2026-05-19T14:22:03.000Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Payment Screening workflow.","required":["transaction_type"],"properties":{"transaction_type":{"type":"string","enum":["transfer"],"description":"Single-select transaction type.","example":"transfer"},"line_of_business":{"type":"string","maxLength":255,"description":"Optional free-form field identifying the line of business the request originates from."},"transaction_details":{"type":"object","description":"Transaction detail fields.","properties":{"memo":{"type":"string","description":"Short transaction description.","example":"Rent July"},"statement_descriptor":{"type":"string","description":"Descriptor that may appear on bank statements.","example":"XYZ Services"}}},"source":{"type":"object","description":"Source party information.","properties":{"amount":{"type":"integer","format":"int64","description":"Amount in minor currency units.","example":25000},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code for the amount.","example":"USD"},"channel":{"type":"string","enum":["web","mobile","pos","other"],"description":"Mode of interaction on the consumer's end.","example":"mobile"},"ip_address":{"type":"string","description":"Consumer IP address in IPv4 or IPv6 format.","example":"203.0.113.10"},"individual":{"$ref":"#/components/schemas/PaymentScreeningIndividual"},"business":{"$ref":"#/components/schemas/PaymentScreeningBusiness"},"external_device":{"$ref":"#/components/schemas/Device"}}},"destination":{"type":"object","description":"Destination party information.","properties":{"amount":{"type":"integer","format":"int64","description":"Amount in minor currency units.","example":24500},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"ISO 4217 currency code for the amount.","example":"USD"},"channel":{"type":"string","enum":["web","mobile","pos","other"],"description":"Mode of interaction on the consumer's end.","example":"mobile"},"ip_address":{"type":"string","description":"Consumer IP address in IPv4 or IPv6 format.","example":"203.0.113.10"},"individual":{"$ref":"#/components/schemas/PaymentScreeningIndividual"},"business":{"$ref":"#/components/schemas/PaymentScreeningBusiness"}}}}}}},"AgeAssurance":{"title":"Age Assurance","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","description":"Your environment-specific Age Assurance workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist.","example":"age_assurance"},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. Reusing an ID causes RiskOS™ to treat the request as a re-run.","example":"test-user-phone"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2026-07-07T12:44:22.059Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"data":{"type":"object","description":"The main payload for the Age Assurance workflow.","properties":{"event_type":{"type":"string","description":"The event category for the evaluation.","example":"identity_verification"},"channel":{"$ref":"#/components/schemas/Channel"},"individual":{"type":"object","description":"Inputs the configured Age Assurance methods resolve age from.","properties":{"given_name":{"type":"string","maxLength":240,"description":"The consumer's given name. Improves passive identity resolution.","example":"Alex"},"family_name":{"type":"string","maxLength":240,"description":"The consumer's family name. Improves passive identity resolution.","example":"Doe"},"phone_number":{"type":"string","description":"The consumer's phone number in E.164 format (e.g., `+12025550147`); hyphens and spaces are tolerated. Required for phone-based assurance.\n","example":"19843359615"},"email":{"type":"string","format":"email","description":"The consumer's email address. Required for email-based assurance.","example":"user@example.com"},"address":{"$ref":"#/components/schemas/Address"},"docv":{"$ref":"#/components/schemas/Docv"},"di_session_token":{"type":"string","description":"Device session token captured by the Digital Intelligence SDK. Required for device-based assurance.","example":"eyJraWQiOi_di_token"}}}}}}},"EvalResponseWithOutSocureData":{"type":"object","description":"The standard Socure RiskOS™ evaluation response.","properties":{"id":{"type":"string","description":"The client-defined request identifier, echoed back in the response.","example":"onb-12345"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"eval_id":{"type":"string","format":"uuid","description":"A unique identifier generated by RiskOS™ for this evaluation. Required for all `GET` and `PATCH` operations.","example":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816"},"workflow":{"type":"string","description":"Your environment-specific workflow executed for this evaluation.","example":"consumer_onboarding"},"workflow_id":{"type":"string","format":"uuid","description":"Unique identifier of the workflow definition that was executed. This value corresponds to the workflow version configured in RiskOS™.","example":"81f5383f-1fbb-46d0-8c26-6964bd9dc3a9"},"eval_status":{"type":"string","description":"The current lifecycle state of the evaluation — for example, `evaluation_in_process`, `evaluation_completed`, or `evaluation_paused`.","example":"evaluation_completed"},"decision":{"type":"string","description":"The final outcome of the evaluation. Possible decision values are:\n* `ACCEPT`: The evaluation is approved; proceed with fulfillment/onboarding and the happy‑path experience.\n* `REVIEW`: Additional assessment is required; route to manual review and/or configured step‑up checks per workflow logic.\n* `REJECT`: The evaluation has failed the required checks and the entity is rejected.\n> **Note:** `ACCEPT`, `REVIEW`, and `REJECT` are the default decision values. Your integration can be customized to use different default decision values based on specific workflow needs.","enum":["ACCEPT","REVIEW","REJECT"],"example":"REVIEW"},"decision_at":{"type":"string","format":"date-time","description":"RFC 3339 timestamp marking when the decision was finalized (UTC).\n","example":"2025-10-17T16:17:17.456721157Z"},"score":{"type":"integer","description":"If configured for a workflow, provides an aggregate sum of the scores assigned to each matched step. Use it for risk banding, additional routing, or analytics alongside the primary `decision` value. The value is determined entirely by your workflow configuration: because you can assign positive or negative scores to individual steps, the aggregate is unbounded and can be negative. Whether a higher value indicates more or less risk depends on how you configure those step scores.","example":91},"status":{"type":"string","description":"Case-level status of the evaluation.","enum":["OPEN","ON_HOLD","CLOSED"],"example":"OPEN"},"sub_status":{"type":"string","description":"Provides additional detail about the evaluation status (for example, `Pending Verification` or `In Review`).","example":"In Review"},"workflow_version":{"type":"string","description":"Version of the executed workflow.","example":"3.7.0"},"eval_source":{"type":"string","description":"Indicates where the evaluation was initiated from. <br />  <br /> Possible values include: \n\n  * `API`: Request submitted via the Evaluation API.\n  * `Dashboard`: Case created or evaluated through the RiskOS™ Dashboard.","enum":["API","Dashboard"],"example":"API"},"eval_start_time":{"type":"string","format":"date-time","description":"RFC 3339 timestamp for when RiskOS™ started processing the evaluation. Useful for latency and performance monitoring.\n","example":"2022-09-01T12:34:56.789Z"},"eval_end_time":{"type":"string","format":"date-time","description":"RFC 3339 timestamp for when RiskOS™ finished processing the evaluation. Can be paired with `eval_start_time` to compute total processing time.\n","example":"2022-09-01T12:34:56.789Z"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of labels applied during the workflow to highlight routing choices, notable signals, or rule outcomes. Useful for reporting, segmentation, or UI highlighting in the RiskOS™ Dashboard.","example":["email_risk","high_risk"]},"decision_tags":{"type":"array","items":{"type":"string"},"description":"Subset of `tags` contributed only by the workflow's terminal decision or manual review step. Use this field when you need the tags that directly explain the final `decision`, without the broader routing and signal tags captured in `tags`.","example":["High Risk"]},"notes":{"type":"string","description":"Freeform text field for analyst or system comments about the evaluation. Often used to capture manual review rationale or investigation context.\n","example":""},"review_queues":{"type":"array","items":{"type":"string"},"description":"Lists any manual review queues the evaluation was sent to. Empty when the case is fully auto-resolved without human review.","example":["Default Queue"]},"data_enrichments":{"type":"array","description":"A collection of external enrichment results generated during the workflow (e.g., device risk checks, KYC verifications, fraud models).","items":{"type":"object","description":"Common metadata shared by every enrichment result, describing the provider and call outcome.","properties":{"enrichment_name":{"type":"string","description":"The human-readable name of the enrichment that executed."},"enrichment_provider":{"type":"string","description":"Identifies the Socure service that processed this enrichment. The value varies by enrichment type — for example, `SocureOTP` for OTP, `SocureSNA` for SNA, and `SocurePaymentScreening` for Payment Screening. Core enrichments such as email risk may return the generic value `Socure`."},"enrichment_endpoint":{"type":"string","description":"The API endpoint used for the enrichment request."},"status_code":{"type":"integer","description":"The provider or orchestration status code for the enrichment attempt.","example":200},"request":{"type":"object","description":"The payload sent to the enrichment provider.","additionalProperties":true},"request_url_params":{"type":"object","description":"Query string parameters sent to the enrichment provider, for enrichments called via URL parameters rather than a request body.","additionalProperties":true},"response":{"type":"object","description":"The data returned from the enrichment provider.","properties":{"referenceId":{"type":"string","description":"Unique identifier assigned to each enrichment after a RiskOS™ workflow is finalized.","example":"b8fbeb31-a2fc-4f1e-a5d1-392c4ed06538"}},"additionalProperties":true},"is_source_cache":{"type":"boolean","description":"Indicates whether the result was returned from source cache instead of a fresh provider call.","example":false},"total_attempts":{"type":"integer","description":"Total number of attempts made to complete the enrichment.","example":1},"error_message":{"type":"string","description":"Error detail when the enrichment request failed or only partially completed.","example":""}}}},"aggregations":{"type":"object","description":"Aggregated data computed across historical evaluations for this entity. Returned when the extended evaluation response is enabled for your account.","additionalProperties":true},"group_id":{"type":"string","description":"Identifier linking related evaluations that belong to the same group (for example, multiple evaluations triggered as part of a single workflow with grouped enrichments).","example":"grp-9f8c2d10"},"input":{"type":"object","description":"The original input data submitted with the evaluation request. Only returned when the `include_input` query parameter is set to `true`.","properties":{"data":{"type":"object","description":"The input data as submitted.","additionalProperties":true},"updated_data":{"type":"object","description":"The input data after any transformations applied by the workflow.","additionalProperties":true}}},"redirect_uri":{"type":"string","description":"Redirect URI for the hosted experience. Returned when the evaluation is initiated through the Hosted UX flow.","example":"https://riskos.sandbox.socure.com/hosted/27017931-f19b-4ae8-b7dc-d11e29331f51"},"computed":{"type":"object","description":"Derived and aggregated results produced by RiskOS™ for quick access. Disabled by default; enable through Socure support if required.","example":{}},"environment_name":{"type":"string","description":"Indicates which environment the evaluation ran in. Typically `Sandbox` for testing or `Production` for live traffic.\n","example":"Sandbox","enum":["Sandbox","Production"]}}},"Error":{"type":"object","description":"Structured error response returned for all non-2xx status codes.","required":["error"],"properties":{"error":{"type":"string","description":"A human-readable error message describing what went wrong.","example":"invalid request payload. please refer invalid_args for details"},"code":{"type":"string","description":"A machine-readable error code for programmatic handling.","example":"INVALID_REQUEST","enum":["AUTHENTICATION_FAILED","PERMISSION_DENIED","WORKFLOW_NOT_FOUND","WORKFLOW_NOT_PUBLISHED","INVALID_REQUEST","INVALID_PAYLOAD","INVALID_ID","INVALID_FRAUD_TYPE","INTERNAL_ERROR","CUSTOMER_METADATA_TOO_LARGE"]},"message":{"type":"string","description":"Additional details or context about the error.","example":"workflow 'test_workflow' does not exist"},"details":{"type":"object","description":"Additional context about the error, such as size limits or constraint details. Present only when extra context is available.","additionalProperties":true},"invalid_args":{"type":"array","description":"Validation errors for specific request fields. Present only for request validation failures.","items":{"type":"object","properties":{"field":{"type":"string","description":"The name of the invalid field.","example":"workflow"},"description":{"type":"string","description":"An explanation of why the field is invalid.","example":"field 'workflow' is required"}}}}}},"ConsumerOnboardingPatch":{"title":"Consumer Onboarding","type":"object","required":["workflow","id","timestamp","data"],"properties":{"workflow":{"type":"string","example":"consumer_onboarding","description":"Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist. <br /><br /> **Note:** The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request."},"id":{"type":"string","description":"Required, customer-defined unique identifier for the request. <br /><br /> This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.","example":"onb-12345"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.\n","example":"2022-09-01T12:34:56.789Z"},"customer_metadata":{"$ref":"#/components/schemas/CustomerMetadata"},"actions":{"type":"object","description":"A top-level container for instructions that modify the lifecycle of the current evaluation session.","properties":{"resume":{"type":"boolean","description":"Set to `true` to force the workflow out of an `ON_HOLD` state. This bypasses the current paused step (for example, OTP entry) so the consumer can fix a typo or switch delivery channels.","example":true}}},"data":{"type":"object","description":"The main payload for the Consumer Onboarding workflow.","example":{"individual":{"email":"updated.email@example.com"}},"properties":{"individual":{"type":"object","description":"Represents core information about the primary consumer.","properties":{"force_resume_evaluation":{"type":"boolean","description":"Optional flag that, if set to `true`, forces the evaluation to skip the current paused step and continue from the next step.\n","example":true},"id":{"type":"string","description":"A unique identifier for a consumer provided by the customer, used across various use cases.","example":"9876543"},"given_name":{"type":"string","description":"The consumer's given name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Dwayne","maxLength":240},"family_name":{"type":"string","description":"The consumer's family name.\n\n**Requirements:**\n- Must be UTF-8 encoded\n- Supports single-byte Latin characters only\n- The following special characters are not supported:\n  ^ ± ! @ £ $ % & * _ + ¡ € # ¢ § ¶ • ª º « < > ? \\ / : ; | =\n","example":"Denver","maxLength":240},"suffix":{"type":"string","description":"A suffix for the consumer's name, if applicable (e.g., Jr., Sr., III).","example":"JR."},"national_id":{"type":"string","description":"The consumer's national identification number. For US consumers, this can be a nine-digit Social Security Number (SSN) or Individual Tax Identification Number (ITIN). Partial SSNs (last four digits) are also accepted. Hyphens are optional.\n","example":"461118208"},"date_of_birth":{"type":"string","format":"date","description":"The consumer's date of birth in the format YYYY-MM-DD, compliant with RFC 3339.","example":"1975-04-02"},"email":{"type":"string","description":"The consumer's email address.","example":"john.doe@example.com"},"alternate_email":{"type":"string","description":"The consumer's alternate email address.","example":"doe.john@example.com"},"phone_number":{"type":"string","description":"The consumer's phone number, including country code.","example":"+1-202-555-0147"},"alternate_phone_number":{"type":"string","description":"The consumer's alternate phone number, including country code.","example":"+1-555-202-0147"},"gender":{"type":"string","enum":["Male","Female","Self Identify"],"description":"The consumer's gender.\n","example":"Male"},"address":{"$ref":"#/components/schemas/Address"},"account":{"$ref":"#/components/schemas/Account"},"docv":{"$ref":"#/components/schemas/Docv"},"otp":{"description":"Contains the OTP data for the transaction.\n\n> **Note:** In a `PATCH` request, the `OTP` object uses the following: \n  - The `code` field to send the OTP code to RiskOS™ for verification. \n  - The `resend` flag to re-trigger the send OTP block. \n","properties":{"code":{"type":"string","description":"The one-time passcode.","example":""},"resend":{"type":"boolean","description":"Set to `true` to trigger a resend of the OTP.","example":false}}},"additional_context":{"$ref":"#/components/schemas/AdditionalContext"},"di_session_token":{"type":"string","description":"Token required to extract Device Intelligence (DI) signals.","example":"SESSION-ABC123"},"custom":{"type":"object","additionalProperties":true,"description":"Send any additional, customer-specific data for this consumer in this field. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}},"additional_individuals":{"description":"Include details of additional consumers if the evaluation involves multiple people. This field allows you to expand the evaluation scope beyond the primary consumer.","type":"array","items":{"$ref":"#/components/schemas/Individual"}},"channel":{"$ref":"#/components/schemas/Channel"},"line_of_business":{"$ref":"#/components/schemas/LineOfBusiness"},"ip_address":{"$ref":"#/components/schemas/IPAddress"},"external_device":{"$ref":"#/components/schemas/Device"},"custom":{"type":"object","additionalProperties":true,"description":"Use this field to send any additional, customer-specific data relevant to the evaluation. See [Custom Fields](https://help.socure.com/riskos/docs/custom-fields) for more information. "}}}}},"FraudFeedbackResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","example":"Fraud feedback updated successfully : id=123456, fraud_label=fraud"}},"example":{"message":"Fraud feedback updated successfully : id=123456, fraud_label=fraud"}},"FraudFeedbackImportResponse":{"type":"object","required":["message"],"properties":{"message":{"type":"string","example":"Fraud feedback file has been submitted successfully for processing"}},"example":{"message":"Fraud feedback file has been submitted successfully for processing"}},"CustomWatchlistErrorItem":{"type":"object","required":["code","message"],"properties":{"field":{"type":"string","description":"The specific field that caused the error, if applicable.","example":"record.entity_name"},"code":{"type":"string","enum":["REQUIRED","INVALID","UNAUTHORIZED","INTERNAL_ERROR","UPSTREAM_ERROR","UPSTREAM_REJECTED","SERVICE_UNAVAILABLE"],"description":"A short code identifying the type of error:\n- `REQUIRED`: A required field was missing from your request.\n- `INVALID`: A field was present but contained an invalid or unsupported value.\n- `UNAUTHORIZED`: Your API key is missing, invalid, or doesn't have access to this resource.\n- `INTERNAL_ERROR`: An unexpected error occurred on Socure's side while processing your request. Retrying later may help.\n- `UPSTREAM_ERROR`: A downstream service Socure depends on failed or timed out. Retrying later may help.\n- `UPSTREAM_REJECTED`: A downstream service explicitly rejected the request (for example, because the record ID already exists). Check the `message` field for details.\n- `SERVICE_UNAVAILABLE`: The service is temporarily unavailable. Retrying later may help.\n","example":"REQUIRED"},"message":{"type":"string","description":"A plain-language explanation of the error, useful for debugging.","example":"record.entity_name is required"}}}},"parameters":{"XApiVersionHeader":{"name":"X-API-Version","in":"header","description":"This header is optional. If omitted, requests use the current default version, `2025-01-01.orion`. Set this header to pin your integration to a specific API version.","required":false,"schema":{"type":"string","example":"2025-01-01.orion"}},"EvalId":{"name":"eval_id","in":"path","required":true,"description":"The system-generated unique ID for the evaluation. Capture this value from the initial `POST` `/api/evaluation` response.","schema":{"type":"string","format":"uuid"},"example":"e9c170f2-b3e4-423b-a373-5d6e1e9b23f8"}},"examples":{"ConsumerOnboardingRequest":{"description":"Consumer Onboarding","value":{"id":"onb-12345","timestamp":"2023-12-01T08:15:30.456Z","workflow":"consumer_onboarding","data":{"line_of_business":"ACME Inc","channel":"web","individual":{"id":"ind-9876543","given_name":"Jane","family_name":"Smith","national_id":"123456789","date_of_birth":"1990-05-15","email":"jane.smith@example.com","phone_number":"+1-312-555-1234","address":{"line_1":"742 Evergreen Terrace","line_2":"Apt 12B","locality":"Springfield","major_admin_division":"IL","country":"US","postal_code":"62704"},"di_session_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ...PiUsws9D6O3DjSjNDCbIJKciX44s","additional_context":{"user_consent":true,"consent_timestamp":"2020-09-13T23:11:12.000Z","mno_status":true}},"ip_address":"203.0.113.10"}}},"OnboardingWithAdvancedPrefillRequest":{"description":"Advanced Prefill","value":{"id":"advanced-prefill-03f1de","timestamp":"2026-04-02T12:00:00Z","workflow":"advanced_pre_fill","data":{"individual":{"phone_number":16673681976,"date_of_birth":"1992-03-11","di_session_token":"YOUR_DI_SESSION_TOKEN"}}}},"GenericPassthroughRequest":{"description":"Generic Passthrough","value":{"id":"genr-12345","timestamp":"2023-12-01T08:15:30.456Z","workflow":"generic_passthrough","data":{"modules":["addressrisk","emailrisk","phonerisk","digitalintelligence"],"individual":{"id":"ind-9876543","given_name":"Jane","family_name":"Smith","national_id":"123456789","date_of_birth":"1990-05-15","email":"jane.smith@example.com","phone_number":"+1-312-555-1234","address":{"line_1":"742 Evergreen Terrace","line_2":"Apt 12B","locality":"Springfield","major_admin_division":"IL","country":"US","postal_code":"62704"},"di_session_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ...PiUsws9D6O3DjSjNDCbIJKciX44s"}}}},"TrustAndSafetyRequest":{"description":"Trust and Safety","value":{"id":"ts-89012","timestamp":"2023-12-01T18:20:34.567Z","workflow":"trust_and_safety","data":{"event_type":"consumer_verification","event_category":"verification","ip_address":"203.0.113.10","individual":{"id":"ind-4567890","given_name":"Alice","family_name":"Johnson","national_id":"123-45-6789","date_of_birth":"1985-03-10","email":"alice.johnson@example.com","phone_number":"+1-415-555-5678","address":{"line_1":"123 Maple Street","line_2":"Suite 200","locality":"San Francisco","major_admin_division":"CA","country":"US","postal_code":"94105"},"di_session_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ...PiUsws9D6O3DjSjNDCbIJKciX44s"},"custom":{}}}},"BankAccountVerificationRequest":{"description":"Bank Account Verification","value":{"workflow":"bank_account_verification","id":"BAV-REQ-123456","timestamp":"2022-09-01T12:34:56.789Z","data":{"individual":{"id":"ind-4567890","given_name":"Alice","family_name":"Johnson","national_id":"123-45-6789","date_of_birth":"1985-03-10","email":"alice.johnson@example.com","phone_number":"+1-415-555-5678","address":{"line_1":"123 Maple Street","line_2":"Suite 200","locality":"San Francisco","major_admin_division":"CA","country":"US","postal_code":"94105"},"di_session_token":"eyJraWQiOiJmMzRiN2YiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.DI_LOW_SCORE","account":{"type":"CHECKING","account_number":"12345678901","routing_number":"122199983","account_inquiries":["AVAILABILITY","OWNERSHIP"]}},"ip_address":"192.168.42.17","additional_context":{"disclosure_purpose":"GLBA_502(e)"},"event_category":"verification","event_type":"account_verification","custom":{},"channel":"mobile"}}},"BusinessOnboardingRequest":{"description":"Business Onboarding","value":{"id":"onb-biz-56789","timestamp":"2023-12-01T10:30:25.789Z","workflow":"business_onboarding","data":{"ip_address":"203.0.113.10","individual":{"id":"ind-4567890","given_name":"Alice","family_name":"Johnson","national_id":"SSN-123-45-6789","date_of_birth":"1985-03-10","email":"alice.johnson@example.com","phone_number":"+1-415-555-5678","address":{"line_1":"123 Maple Street","line_2":"Suite 200","locality":"San Francisco","major_admin_division":"CA","country":"US","postal_code":"94105"},"di_session_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ...PiUsws9D6O3DjSjNDCbIJKciX44s"},"business":{"name":"Tech Innovators LLC","ein":"12-3456789","phone_number":"+1-800-555-6789","address":{"line_1":"456 Innovation Drive","line_2":"Floor 5","locality":"Mountain View","major_admin_division":"CA","country":"US","postal_code":"94043"},"formation":{"entity_type":"Limited Liability Company (LLC)","registration_date":"2020-08-15","registration_state":"CA","registration_country":"US"},"website_url":"https://techinnovators.com","last_fiscal_revenue":{"amount":2500000,"currency":"USD"},"account":{"type":"CHECKING","account_number":"9876543210123456","routing_number":"123456789","opened_at":"2021-06-15T08:20:45.123Z","country_code":"US"}}}}},"AccountTakeOverRequest":{"description":"Login and Authentication","value":{"id":"ato-78901","timestamp":"2023-12-01T15:45:12.678Z","workflow":"account_takeover","data":{"event_type":"address_update","event_category":"update","ip_address":"203.0.113.10","individual":{"id":"ind-9876543","given_name":"Jane","family_name":"Smith","national_id":"123456789","date_of_birth":"1990-05-15","email":"jane.smith@example.com","phone_number":"+1-312-555-1234","address":{"line_1":"742 Evergreen Terrace","line_2":"Apt 12B","locality":"Springfield","major_admin_division":"IL","country":"US","postal_code":"62704"},"di_session_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ...PiUsws9D6O3DjSjNDCbIJKciX44s"},"event_details":{"previous":{"address":{"line_1":"123 Main Street","line_2":"Suite 100","locality":"Brooklyn","major_admin_division":"NY","country":"US","postal_code":"11201"}}},"custom":{}}}},"WorkforceVerificationRequest":{"description":"Workforce Verification","value":{"id":"a86580cc-1733-4188-86b5-717166e1db8c","workflow":"trust_and_safety","timestamp":"2025-05-02T12:44:22.059Z","data":{"event_type":"application_submitted","event_category":"workforce_verification","individual":{"id":"09237776-f16b-4eec-9305-fc425843d887","given_name":"John","family_name":"Smith","email":"john.smith@gmail.com","phone_number":"1-310-841-6189","address":{"line_1":"123 Main Street","locality":"New York","major_admin_division":"NY","country":"US","postal_code":"10001"},"di_session_token":"eyJraWQiOiJmMzRiN2YiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.DI_LOW_SCORE"}}}},"PaymentScreeningIndividualRequest":{"description":"Payment Screening: Individual to Individual","value":{"workflow":"payment_screening","id":"txn-007341829056","timestamp":"2026-05-19T14:22:03.000Z","data":{"transaction_type":"transfer","transaction_details":{"memo":"Personal transfer","statement_descriptor":"XFR 007341829056"},"source":{"amount":25000,"currency":"USD","individual":{"id":"src-ind-001","given_name":"Emily","family_name":"Chen","date_of_birth":"1988-04-12","address":{"line_1":"4521 Westwood Blvd","locality":"Los Angeles","major_admin_division":"CA","country":"US","postal_code":"90064","type":"HOME"},"instrument":{"type":"BANK_ACCOUNT","account":{"id":"src-acct-001","type":"CHECKING","account_number":"483920175634","routing_number":"021000021","institution_name":"JPMorgan Chase Bank","swift_bic":"CHASUS33"}}}},"destination":{"amount":24500,"currency":"USD","individual":{"id":"dst-ind-001","given_name":"Andrey","family_name":"Kostin","date_of_birth":"1956-09-21","address":{"line_1":"29 Degtyarny Pereulok","locality":"Moscow","country":"RU","postal_code":"127994"},"instrument":{"type":"BANK_ACCOUNT","account":{"id":"dst-acct-001","type":"CHECKING","institution_name":"Raiffeisen Bank International","swift_bic":"RZBAATWW"}}}}}}},"AgeAssuranceRequest":{"description":"Age Assurance","value":{"id":"test-user-phone","timestamp":"2026-07-07T12:44:22.059Z","workflow":"age_assurance","data":{"event_type":"identity_verification","channel":"web","individual":{"given_name":"Alex","family_name":"Doe","phone_number":"19843359615","email":"user@example.com","address":{"country":"US"},"docv":{"config":{"language":"en","send_message":false}}}}}},"ConsumerOnboardingResponse":{"description":"Consumer Onboarding","value":{"id":"onb-12345","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"consumer_onboarding","eval_status":"evaluation_completed","decision":"REJECT","status":"CLOSED","sub_status":"Reject","workflow_id":"472288ff-b3a8-4e69-89dd-069d5e2bcb41","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":["High Risk","Bad Device"],"score":146,"review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Verify","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["kyc"],"firstName":"Jonathan","surName":"Reyes","dob":"1979-07-30","nationalId":"1234","physicalAddress":"123 Rizal Avenue","city":"Portland","state":"OR","zip":"97223","country":"US","mobileNumber":"+639171234567","email":"jonathan.reyes1979@gmail.com"},"response":{"referenceId":"b8fbeb31-a2fc-4f1e-a5d1-392c4ed06538","kyc":{"socureId":"46fd3b11-a130-4915-8cc4-074bbd799669","reasonCodes":["I919"],"fieldValidations":{"firstName":0.99,"surName":0.99,"streetAddress":0.99,"city":0.99,"state":0.99,"zip":0.99,"mobileNumber":0.99,"dob":0.99,"ssn":0.99},"fieldSourceAttribution":{"ssn":["Social Security Administration"],"address":["USPS","Utility Records"],"mobileNumber":["Telecom Carrier"]},"sourceAttribution":["Credit","Telco"],"matchCounts":{"tradelines":3},"creditFileNumber":"00512123456","additionalInfo":{"tradelines":3},"transactionScope":"international"}},"is_source_cache":false},{"enrichment_name":"Socure Verify Plus","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["kycplus"],"firstName":"Jonathan","surName":"Reyes","dob":"1979-07-30","nationalId":"1234","physicalAddress":"123 Rizal Avenue","city":"Portland","state":"OR","zip":"97223","country":"US","mobileNumber":"+639171234567","email":"jonathan.reyes1979@gmail.com"},"response":{"referenceId":"b8fbeb31-a2fc-4f1e-a5d1-392c4ed06538","kycPlus":{"socureId":"46fd3b11-a130-4915-8cc4-074bbd799669","reasonCodes":["I919"],"fieldValidations":{"firstName":0.99,"surName":0.99,"streetAddress":0.99,"city":0.99,"state":0.99,"zip":0.99,"mobileNumber":0.99,"dob":0.99,"ssn":0.99},"sourceAttribution":["Credit","Telco"],"bestMatchedEntity":{"firstName":"John","middleName":"Michael","surName":"Doe"}}},"is_source_cache":false},{"enrichment_name":"Socure Sigma Synthetic","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["synthetic"],"firstName":"Shannon","surName":"Zhao","nationalId":"123456789","dob":"1958-01-31","email":"j.smith@example.com","phone":"+13475551234","streetAddress":"234 Main Street","city":"Jersey City","state":"NJ","zip":"07307","ipAddress":"10.10.10.10","country":"US"},"response":{"referenceId":"f9012345-6789-abcd-ef01-234567890abc","synthetic":{"reasonCodes":["I912","R557","R615"],"scores":[{"name":"synthetic","version":"4.0","score":0.911}]}},"is_source_cache":false},{"enrichment_name":"Socure Sigma Identity Fraud","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["fraud"],"firstName":"Shannon","surName":"Zhao","nationalId":"461118208","dob":"1975-04-02","email":"shannon.zhao@example.com","phone":"+14155550100","ipAddress":"10.10.10.10","country":"US"},"response":{"referenceId":"d7e8f901-2345-6789-abcd-ef0123456789","fraud":{"reasonCodes":["I301","I303"],"scores":[{"name":"Sigma Identity Fraud (US)","version":"5.0","score":0.923}]}},"is_source_cache":false},{"enrichment_name":"Socure Address Risk","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["addressrisk"],"firstName":"Maria","surName":"Lopez","mobileNumber":"+13051234567","physicalAddress":"123 Main Street","city":"Miami","state":"FL","zip":"33101","country":"US"},"response":{"referenceId":"4ca693ee-af2a-45ef-9688-834683ac1b34","nameAddressCorrelation":{"score":0.84,"reasonCodes":["I700"]},"addressRisk":{"reasonCodes":["I704","I705","I708"],"scores":[{"name":"Address Risk Model (US) Norm","version":"3.2","score":0.921}]}},"is_source_cache":false},{"enrichment_name":"Socure eCBSV","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["ecbsv"],"firstName":"Shannon","surName":"Zhao","dob":"1973-06-20","nationalId":"136582341","country":"US","userConsent":true,"consentTimestamp":"2025-01-15T10:30:00Z"},"response":{"referenceId":"f3863a33-69ca-43c2-90e0-8b4344a41a09","eCBSV":{"reasonCodes":["I998","I999"]}},"is_source_cache":false},{"enrichment_name":"Socure Sigma First-Party Fraud","enrichment_provider":"Socure","enrichment_endpoint":"/api/3.0/EmailAuthScore","status_code":200,"request":{"modules":["firstpartyfraud"],"disclosurePurpose":"GLBA_502(e)","firstName":"Shannon","surName":"Zhao","nationalId":"461118208","dob":"1975-04-02","email":"shannon.zhao@example.com","mobileNumber":"+14155550100","physicalAddress":"234 Main Street","city":"Jersey City","state":"NJ","zip":"07307","country":"US"},"response":{"referenceId":"e8f90123-4567-89ab-cdef-012345678901","firstPartyFraud":{"scores":[{"name":"Identity Manipulation","version":"3.0","score":0.847}],"reasonCodes":["I401","I405"]}},"is_source_cache":false},{"enrichment_name":"Socure Phone Risk SIM Swap","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"mobileNumber":"+13475550100","firstName":"Guillermo","surName":"McNeil","physicalAddress":"742 Evergreen Terrace","city":"San Francisco","state":"CA","zip":"94105","country":"US","mnoStatus":true},"response":{"referenceId":"68bb36f1-7e32-4600-bebf-26a6cdd39f8b","namePhoneCorrelation":{"score":0.92,"reasonCodes":["I600"]},"phoneRisk":{"reasonCodes":["I618","I608","I699"],"scores":[{"name":"Phone Risk Model (US) Norm","version":"6.0","score":0.781}]}},"is_source_cache":false,"total_attempts":1}],"environment_name":"Sandbox"}},"OnboardingWithAdvancedPrefillResponse":{"description":"Advanced Prefill","value":{"id":"advanced-prefill-03f1de","eval_id":"7bc4b7c8-eb67-429b-919a-cdc9ab3c590f","workflow":"advanced_pre_fill","eval_status":"evaluation_completed","decision":"ACCEPT","status":"CLOSED","eval_start_time":"2026-04-02T12:00:00.196Z","eval_end_time":"2026-04-02T12:00:02.007Z","tags":["none"],"data_enrichments":[{"enrichment_name":"Socure Prefill","enrichment_provider":"Socure","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","status_code":200,"response":{"customerProfile":{"userId":"555adc5d-5f55-555b-a5ef-5555a4555ce5"},"prefill":{"socureId":"afe5bd55-a555-5555-55bb-55f55a55ed5c","firstName":"Bart","middleName":"A","surName":"Lambert","suffix":"Jr","aliases":["el barto"],"dob":"2001-01-10","nationalId":"567905555","mobileNumber":15556678910,"associatedPhoneNumbers":[{"phoneNumber":15556678910,"isMatched":true,"isLatest":true,"firstSeenDate":"2020-07-01","lastSeenDate":"2025-11-01"}],"associatedEmails":[{"emailAddress":"myemail@gmail.com","isMatched":true,"isLatest":false,"firstSeenDate":"2010-01-28","lastSeenDate":"2026-03-22"}],"associatedAddresses":[{"streetAddress":"123 4th Ave","city":"Springfield","county":"Lane","state":"OR","zip":"55668","isMatched":false,"firstSeenDate":"","lastSeenDate":"","isLatest":true}]},"referenceId":"555e5555-55e5-5a55-5555-f5dcfddd5555"},"is_source_cache":false,"total_attempts":1}]}},"GenericPassthroughResponse":{"description":"Generic Passthrough","value":{"id":"genr-12345","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"generic_passthrough","eval_status":"evaluation_completed","decision":"REJECT","status":"CLOSED","sub_status":"passthrough","workflow_id":"472288ff-b3a8-4e69-89dd-069d5e2bcb41","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":[],"review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Address risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"city":"Springfield","country":"US","deviceSessionId":"234ac3ff-3ed1-42de-8f33-8f332febfa54","dob":"1990-05-15","email":"jane.smith@example.com","modules":["addressrisk"],"nationalId":"123456789"},"response":{"addressRisk":{"reasonCodes":["I704","I705","I708"],"scores":[{"name":"addressrisk_cus1","score":0.01,"version":"10.0"},{"name":"address_risk_pri","score":0.01,"version":"9.0"}]},"referenceId":"4ca693ee-af2a-45ef-9688-834683ac1b34"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Email Risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["emailrisk"],"email":"jane.smith@example.com"},"response":{"emailRisk":{"reasonCodes":["I520","I555"],"scores":[{"name":"email_risk_cus1","score":0.01,"version":"10.0"}]},"referenceId":"92201637-1ec8-46b4-9537-236971eb6f9b"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Phone Risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["phonerisk"],"email":"jane.smith@example.com"},"response":{"phoneRisk":{"reasonCodes":["I618","I608"],"scores":[{"name":"RiskPhoneUS.V6.Norm.V1","score":0.01,"version":"6.0"}]},"referenceId":"68bb36f1-7e32-4600-bebf-26a6cdd39f8b"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Digital Intelligence","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["digitalintelligence"],"deviceSessionId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","customerUserId":"129","userId":"dwanyedever1975"},"response":{"referenceId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","digitalIntelligence":{"device":{"id":"234ac3ff-3ed1-42de-8f33-8f332febfa54","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},"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","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":[]},"iOSAttributes":{"isRooted":true,"mobileNetwork":[]},"webAttributes":{"userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/21A5291h [FBAN/FBIOS;FBDV/iPhone15,3;FBMD/iPhone;FBSN/iOS;FBSV/17.0;FBSS/3;FBID/phone;FBLC/fr_FR;FBOP/5]","userAgentExtractionRequired":true,"browser":"Google Chrome","browserVersion":116}},"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}},"entityProfiler":[{"entity":"12223334444","entityType":"phone","profile":{"seenCount":2,"firstSeen":"2019-08-24T14:15:22Z","lastSeen":"2019-08-24T14:15:22Z","deviceTypes":["phone","tablet"],"deviceModels":["iphone14,7","GT70053G"],"deviceIsps":["comcast","t-mobile"],"deviceLanguages":["en-us","es-us"],"deviceTimezones":["america/new_york","america/los_angeles"],"networkLocationStates":["ca","az"],"networkLocationPostalCodes":["12345","56789"]}},{"entity":"john@doe.com","entityType":"email","profile":{"seenCount":5,"firstSeen":"2020-09-10T10:22:45Z","lastSeen":"2020-09-15T13:45:32Z","deviceTypes":["phone","desktop"],"deviceModels":["moto g"],"deviceIsps":["at&t"],"deviceLanguages":["en-us"],"deviceTimezones":["america/los_angeles"],"networkLocationStates":["or"],"networkLocationPostalCodes":["56789"]}},{"entity":"111223333","entityType":"nationalId","profile":{"seenCount":3,"firstSeen":"2023-01-15T09:30:00Z","lastSeen":"2023-09-10T14:45:00Z","deviceTypes":["phone","tablet"],"deviceModels":["GT70053G"],"deviceIsps":["comcast"],"deviceLanguages":["de_us"],"deviceTimezones":["america/chicago"],"networkLocationStates":["il"],"networkLocationPostalCodes":["12345"]}}],"velocityMetrics":{"historicalCount":{"firstName":{"uniqueCount":1,"uniqueSharePercent":100},"surName":{"uniqueCount":1,"uniqueSharePercent":100},"email":{"uniqueCount":2,"uniqueSharePercent":87},"mobileNumber":{"uniqueCount":1,"uniqueSharePercent":100}}}},"customerProfile":{"customerUserId":"129","userId":"u8JpWn4QsF3R7tA2"}},"is_source_cache":false,"total_attempts":1}],"environment_name":"Sandbox"}},"TrustAndSafetyResponse":{"description":"Trust and Safety","value":{"id":"ts-89012","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"trust_and_safety","eval_status":"evaluation_completed","decision":"ACCEPT","status":"CLOSED","sub_status":"Accept","workflow_id":"472288ff-b3a8-4e69-89dd-069d5e2bcb41","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":["verified","low risk"],"score":-76,"review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Address risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"city":"bakersfield","country":"US","deviceSessionId":"234ac3ff-3ed1-42de-8f33-8f332febfa54","dob":"1990-05-17","email":"johnsmith123+test@example.com","modules":["addressrisk"],"nationalId":"454236793"},"response":{"addressRisk":{"reasonCodes":["I704","I705","I708"],"scores":[{"name":"addressrisk_cus1","score":0.01,"version":"10.0"},{"name":"address_risk_pri","score":0.01,"version":"9.0"}]},"referenceId":"4ca693ee-af2a-45ef-9688-834683ac1b34"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Email Risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["emailrisk"],"email":"johnsmith123+test@example.com"},"response":{"emailRisk":{"reasonCodes":["I520","I555"],"scores":[{"name":"email_risk_cus1","score":0.01,"version":"10.0"}]},"referenceId":"92201637-1ec8-46b4-9537-236971eb6f9b"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Phone Risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["phonerisk"],"email":"johnsmith123+test@example.com"},"response":{"phoneRisk":{"reasonCodes":["I618","I608"],"scores":[{"name":"RiskPhoneUS.V6.Norm.V1","score":0.01,"version":"6.0"}]},"referenceId":"68bb36f1-7e32-4600-bebf-26a6cdd39f8b"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"SocureCNam","enrichment_endpoint":"https://sandbox.socure.com/api/2.0/cnam","enrichment_provider":"SocureCNam","status_code":200,"request":{"phoneNumber":"+1-415-555-5678"},"response":{"callerName":"Alice Johnson","callerType":"CONSUMER","countryCode":"US","phoneNumber":"+1-312-555-1234","valid":true},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Digital Intelligence","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["digitalintelligence"],"deviceSessionId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","customerUserId":"129","userId":"dwanyedever1975"},"response":{"referenceId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","digitalIntelligence":{"device":{"id":"234ac3ff-3ed1-42de-8f33-8f332febfa54","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},"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","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":[]},"iOSAttributes":{"isRooted":true,"mobileNetwork":[]},"webAttributes":{"userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/21A5291h [FBAN/FBIOS;FBDV/iPhone15,3;FBMD/iPhone;FBSN/iOS;FBSV/17.0;FBSS/3;FBID/phone;FBLC/fr_FR;FBOP/5]","userAgentExtractionRequired":true,"browser":"Google Chrome","browserVersion":116}},"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}},"entityProfiler":[{"entity":"12223334444","entityType":"phone","profile":{"seenCount":2,"firstSeen":"2019-08-24T14:15:22Z","lastSeen":"2019-08-24T14:15:22Z","deviceTypes":["phone","tablet"],"deviceModels":["iphone14,7","GT70053G"],"deviceIsps":["comcast","t-mobile"],"deviceLanguages":["en-us","es-us"],"deviceTimezones":["america/new_york","america/los_angeles"],"networkLocationStates":["ca","az"],"networkLocationPostalCodes":["12345","56789"]}},{"entity":"john@doe.com","entityType":"email","profile":{"seenCount":5,"firstSeen":"2020-09-10T10:22:45Z","lastSeen":"2020-09-15T13:45:32Z","deviceTypes":["phone","desktop"],"deviceModels":["moto g"],"deviceIsps":["at&t"],"deviceLanguages":["en-us"],"deviceTimezones":["america/los_angeles"],"networkLocationStates":["or"],"networkLocationPostalCodes":["56789"]}},{"entity":"111223333","entityType":"nationalId","profile":{"seenCount":3,"firstSeen":"2023-01-15T09:30:00Z","lastSeen":"2023-09-10T14:45:00Z","deviceTypes":["phone","tablet"],"deviceModels":["GT70053G"],"deviceIsps":["comcast"],"deviceLanguages":["de_us"],"deviceTimezones":["america/chicago"],"networkLocationStates":["il"],"networkLocationPostalCodes":["12345"]}}],"velocityMetrics":{"historicalCount":{"firstName":{"uniqueCount":1,"uniqueSharePercent":100},"surName":{"uniqueCount":1,"uniqueSharePercent":100},"email":{"uniqueCount":2,"uniqueSharePercent":87},"mobileNumber":{"uniqueCount":1,"uniqueSharePercent":100}}}},"customerProfile":{"customerUserId":"129","userId":"u8JpWn4QsF3R7tA2"}},"is_source_cache":false,"total_attempts":1}],"environment_name":"Sandbox"}},"BankAccountVerificationResponse":{"description":"Bank Account Verification","value":{"id":"onb-12345","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"bank_account_verification","eval_status":"evaluation_completed","decision":"REJECT","status":"CLOSED","sub_status":"Reject","workflow_id":"472288ff-b3a8-4e69-89dd-069d5e2bcb41","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":["High Risk Account","Bad Device"],"score":278,"review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Account Intelligence","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["accountintelligence"],"firstName":"Johnny","surName":"Aiken","physicalAddress":"2 Moran Ave","city":"Danbury","state":"CT","zip":68100000,"country":"US","nationalId":"700-01-3784","mobileNumber":"+12037986508","dob":"1958-01-31","payments":{"account":{"accountNumber":"92301962561","routingNumber":"122199983","inquiries":["AVAILABILITY","OWNERSHIP"]}}},"response":{"referenceId":"f3863a33-69ca-43c2-90e0-8b4344a41a09","accountIntelligence":{"reasonCodes":["I334"],"account":{"availabilityScore":0.99}}}},{"enrichment_name":"Socure Digital Intelligence","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["digitalintelligence"],"deviceSessionId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","customerUserId":"129","userId":"dwanyedever1975"},"response":{"referenceId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","digitalIntelligence":{"device":{"id":"234ac3ff-3ed1-42de-8f33-8f332febfa54","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},"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","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":[]},"iOSAttributes":{"isRooted":true,"mobileNetwork":[]},"webAttributes":{"userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/21A5291h [FBAN/FBIOS;FBDV/iPhone15,3;FBMD/iPhone;FBSN/iOS;FBSV/17.0;FBSS/3;FBID/phone;FBLC/fr_FR;FBOP/5]","userAgentExtractionRequired":true,"browser":"Google Chrome","browserVersion":116}},"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}},"entityProfiler":[{"entity":"12223334444","entityType":"phone","profile":{"seenCount":2,"firstSeen":"2019-08-24T14:15:22Z","lastSeen":"2019-08-24T14:15:22Z","deviceTypes":["phone","tablet"],"deviceModels":["iphone14,7","GT70053G"],"deviceIsps":["comcast","t-mobile"],"deviceLanguages":["en-us","es-us"],"deviceTimezones":["america/new_york","america/los_angeles"],"networkLocationStates":["ca","az"],"networkLocationPostalCodes":["12345","56789"]}},{"entity":"john@doe.com","entityType":"email","profile":{"seenCount":5,"firstSeen":"2020-09-10T10:22:45Z","lastSeen":"2020-09-15T13:45:32Z","deviceTypes":["phone","desktop"],"deviceModels":["moto g"],"deviceIsps":["at&t"],"deviceLanguages":["en-us"],"deviceTimezones":["america/los_angeles"],"networkLocationStates":["or"],"networkLocationPostalCodes":["56789"]}},{"entity":"111223333","entityType":"nationalId","profile":{"seenCount":3,"firstSeen":"2023-01-15T09:30:00Z","lastSeen":"2023-09-10T14:45:00Z","deviceTypes":["phone","tablet"],"deviceModels":["GT70053G"],"deviceIsps":["comcast"],"deviceLanguages":["de_us"],"deviceTimezones":["america/chicago"],"networkLocationStates":["il"],"networkLocationPostalCodes":["12345"]}}],"velocityMetrics":{"historicalCount":{"firstName":{"uniqueCount":1,"uniqueSharePercent":100},"surName":{"uniqueCount":1,"uniqueSharePercent":100},"email":{"uniqueCount":2,"uniqueSharePercent":87},"mobileNumber":{"uniqueCount":1,"uniqueSharePercent":100}}}},"customerProfile":{"customerUserId":"129","userId":"u8JpWn4QsF3R7tA2"}},"is_source_cache":false,"total_attempts":1}],"environment_name":"Sandbox"}},"BusinessOnboardingResponse":{"description":"Business Onboarding","value":{"id":"onb-biz-56789","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"business_onboarding","eval_status":"evaluation_completed","decision":"REVIEW","status":"CLOSED","sub_status":"In Review","workflow_id":"472288ff-b3a8-4e69-89dd-069d5e2bcb41","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":["Medium Risk","SOS Missing"],"score":15,"review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Address risk","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"city":"bakersfield","country":"US","deviceSessionId":"234ac3ff-3ed1-42de-8f33-8f332febfa54","dob":"1990-05-17","email":"johnsmith123+test@example.com","modules":["addressrisk"],"nationalId":"454236793"},"response":{"addressRisk":{"reasonCodes":["I704","I705","I708"],"scores":[{"name":"addressrisk_cus1","score":0.01,"version":"10.0"},{"name":"address_risk_pri","score":0.01,"version":"9.0"}]},"referenceId":"4ca693ee-af2a-45ef-9688-834683ac1b34"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"SocureCNam","enrichment_endpoint":"https://sandbox.socure.com/api/2.0/cnam","enrichment_provider":"SocureCNam","status_code":200,"request":{"phoneNumber":"+1-312-555-1234"},"response":{"callerName":"John Smith","callerType":"BUSINESS","countryCode":"US","phoneNumber":"+1-415-555-5678","valid":true},"is_source_cache":false,"total_attempts":1}],"environment_name":"Sandbox"}},"AccountTakeOverResponse":{"description":"Login and Authentication","value":{"id":"ato-78901","eval_id":"6dc8f39c-ecc3-4fe0-9283-fc8e5f99e816","workflow":"account_takeover","eval_status":"evaluation_completed","decision":"REJECT","status":"CLOSED","sub_status":"Reject","workflow_id":"472288ff-b3a8-4e69-89dd-069d5e2bcb41","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2024-12-02T10:28:24.456771162Z","eval_end_time":"2024-12-02T10:29:10.999Z","tags":["account ta","high risk"],"score":-76,"review_queues":[],"data_enrichments":[{"enrichment_name":"SocureCNam","enrichment_endpoint":"https://sandbox.socure.com/api/2.0/cnam","enrichment_provider":"SocureCNam","status_code":200,"request":{"phoneNumber":"+1-312-555-1234"},"response":{"callerName":"Jane Smith","callerType":"CONSUMER","countryCode":"US","phoneNumber":"+1-312-555-1234","valid":true},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Digital Intelligence","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"modules":["digitalintelligence"],"deviceSessionId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","customerUserId":"129","userId":"dwanyedever1975"},"response":{"referenceId":"7b3c2c04-0e7e-46e4-afe8-b905cdf91833","digitalIntelligence":{"device":{"id":"234ac3ff-3ed1-42de-8f33-8f332febfa54","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},"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","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":[]},"iOSAttributes":{"isRooted":true,"mobileNetwork":[]},"webAttributes":{"userAgent":"Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/21A5291h [FBAN/FBIOS;FBDV/iPhone15,3;FBMD/iPhone;FBSN/iOS;FBSV/17.0;FBSS/3;FBID/phone;FBLC/fr_FR;FBOP/5]","userAgentExtractionRequired":true,"browser":"Google Chrome","browserVersion":116}},"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}},"entityProfiler":[{"entity":"12223334444","entityType":"phone","profile":{"seenCount":2,"firstSeen":"2019-08-24T14:15:22Z","lastSeen":"2019-08-24T14:15:22Z","deviceTypes":["phone","tablet"],"deviceModels":["iphone14,7","GT70053G"],"deviceIsps":["comcast","t-mobile"],"deviceLanguages":["en-us","es-us"],"deviceTimezones":["america/new_york","america/los_angeles"],"networkLocationStates":["ca","az"],"networkLocationPostalCodes":["12345","56789"]}},{"entity":"john@doe.com","entityType":"email","profile":{"seenCount":5,"firstSeen":"2020-09-10T10:22:45Z","lastSeen":"2020-09-15T13:45:32Z","deviceTypes":["phone","desktop"],"deviceModels":["moto g"],"deviceIsps":["at&t"],"deviceLanguages":["en-us"],"deviceTimezones":["america/los_angeles"],"networkLocationStates":["or"],"networkLocationPostalCodes":["56789"]}},{"entity":"111223333","entityType":"nationalId","profile":{"seenCount":3,"firstSeen":"2023-01-15T09:30:00Z","lastSeen":"2023-09-10T14:45:00Z","deviceTypes":["phone","tablet"],"deviceModels":["GT70053G"],"deviceIsps":["comcast"],"deviceLanguages":["de_us"],"deviceTimezones":["america/chicago"],"networkLocationStates":["il"],"networkLocationPostalCodes":["12345"]}}],"velocityMetrics":{"historicalCount":{"firstName":{"uniqueCount":1,"uniqueSharePercent":100},"surName":{"uniqueCount":1,"uniqueSharePercent":100},"email":{"uniqueCount":2,"uniqueSharePercent":87},"mobileNumber":{"uniqueCount":1,"uniqueSharePercent":100}}}},"customerProfile":{"customerUserId":"129","userId":"u8JpWn4QsF3R7tA2"}},"is_source_cache":false,"total_attempts":1}],"environment_name":"Sandbox"}},"WorkforceVerificationResponse":{"description":"Workforce Verification","value":{"id":"a86580cc-1733-4188-86b5-717166e1db8c","workflow":"trust_and_safety","workflow_id":"cdefa08b-5dce-4b0a-a87a-23693c01b5e5","workflow_version":"4.36.0","eval_source":"API","eval_id":"3d848e40-c166-4d30-bd84-03f1de461be3","eval_start_time":"2025-09-25T16:37:26.668697863Z","eval_end_time":"2025-09-25T16:37:27.27007937Z","decision":"REJECT","decision_at":"2025-09-25T16:37:27.269920344Z","status":"CLOSED","sub_status":"Reject","tags":[],"notes":"","review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Digital Intelligence","enrichment_endpoint":"https://sandbox.socure.com/api/3.0/EmailAuthScore","enrichment_provider":"Socure","status_code":200,"request":{"city":"New York","country":"US","deviceSessionId":"eyJraWQiOiJmMzRiN2YiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.DI_LOW_SCORE","email":"john.smith@gmail.com","firstName":"John","mobileNumber":"1-310-841-6189","modules":["digitalintelligence"],"parentTxnId":"3d848e40-c166-4d30-bd84-03f1de461be3","physicalAddress":"123 Main Street","riskOSId":"a86580cc-1733-4188-86b5-717166e1db8c","state":"NY","surName":"Smith","userId":"09237776-f16b-4eec-9305-fc425843d887","workflow":"trust_and_safety","zip":"10001"},"response":{"customerProfile":{"userId":"09237776-f16b-4eec-9305-fc425843d887"},"digitalIntelligence":{"behavioral":{"aggregations":{"blurCount":0,"clickCount":0,"focusCount":0,"inputChangeCount":0,"pasteCount":0,"submissionCount":0,"totalEventCount":0},"duration":750,"serverCreated":"2025-01-14T00:10:50.942Z","serverUpdated":"2025-01-14T00:10:51.692Z","sessionId":"a1cf60e7-5915-4734-9130-223c8371f12a","source":"http://localhost:3000/"},"device":{"attributes":{"androidAttributes":{},"battery":{"batteryLevel":0.88,"batteryState":"charging"},"deviceManufacturer":"Apple","deviceModel":"Apple Macintosh","devicePixelRatio":1.1,"deviceType":"Desktop","iOSAttributes":{},"language":"en-US","location":{},"os":"Mac OS","osVersion":"14.5.0","platform":"Web","screenHeight":1080,"screenWidth":1920,"sdkVersion":"2.5.0","timeZone":"America/Los_Angeles","timeZoneOffset":-480,"viewportHeight":668,"viewportWidth":598,"webAttributes":{"browser":"Chrome","browserVersion":"131.0.6778.205","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36","userAgentExtractionRequired":true}},"computed":{"isVirtualMachine":false,"sessionAgeMinutes":45,"deviceNetworkTimezoneOffsetDiffMinutes":60,"statisticalId":"e81a14d6621cfd2ed9390be9d9eba266851e391aa751881cda9f74377197980b"},"deviceCaptureAt":"2025-01-14T00:10:51.692Z","history":{"daysSeen":["2025-01-08","2025-01-14"],"firstSeen":"2025-01-08T15:55:46.143356159Z","ips":["192.184.177.36","105.30.177.22"],"isps":["sonic.net llc","cloudflare inc."],"lastSeen":"2025-01-14T00:10:49.385195428Z","networkLocations":["houston,  ca","new york,  ny"]},"id":"844da0ea-767a-48da-8cb5-5f2e179f43f4","network":{"asn":13335,"asnName":"cloudflare inc.","connectionIp":"105.30.177.22","domainName":"cloudflare.com","isConsumerPrivacy":false,"isMobileCarrier":false,"isProxy":true,"isRiskyNetwork":true,"isTor":false,"isVpn":false,"isp":"cloudflare inc.","ispType":"business","networkLocation":{"city":"new york","continentCode":"NA","countryCode":"us","gmtOffset":"-500","latitude":60.8,"longitude":-73.97,"metroCode":501,"postalCode":"10025","region":"ny","timezoneName":"america/new_york"},"org":"cloudflare inc.","realIp":"105.30.177.22","speed":"broadband","webRtcInternalIp":"105.30.177.22","webRtcPublicIp":"105.30.177.22"},"sessionCreatedAt":"2025-01-14T00:10:50.942Z"},"entityProfiler":[{"entity":"test123@tester.com","entityType":"email","profile":{}},{"entity":"+14159999999","entityType":"phone","profile":{"deviceIsps":["att internet services"],"deviceLanguages":["en-us"],"deviceModels":["9137w"],"deviceTimezones":["america/los_angeles"],"deviceTypes":[],"firstSeen":"2019-08-30","lastSeen":"2025-01-06","networkLocationPostalCodes":["95035"],"networkLocationStates":["ca"],"seenCount":30}}],"velocityMetrics":{"historicalCount":{"email":{"uniqueCount":0,"uniqueSharePercent":0},"firstName":{"uniqueCount":0,"uniqueSharePercent":0},"mobileNumber":{"uniqueCount":0,"uniqueSharePercent":0},"surName":{"uniqueCount":0,"uniqueSharePercent":0}}}},"referenceId":"4b905868-9d20-4d1c-9fde-544aeede981f"},"is_source_cache":false,"total_attempts":1}],"eval_status":"evaluation_completed","score":72,"environment_name":"Sandbox"}},"PaymentScreeningIndividualResponse":{"description":"Payment Screening: Individual to Individual","value":{"id":"txn-007341829056","workflow":"payment_screening","workflow_id":"b030778a-e8b9-4bba-8a1a-4126ad6e90c4","workflow_version":"2.9.0","eval_source":"API","eval_id":"809a7984-63ca-4571-9ab9-70beb202fc5f","eval_start_time":"2026-05-20T05:09:09.737955462Z","eval_end_time":"2026-05-20T05:09:11.046489573Z","decision":"REJECT","decision_at":"2026-05-20T05:09:11.046371316Z","status":"CLOSED","sub_status":"Reject","tags":[],"notes":"","review_queues":[],"data_enrichments":[{"enrichment_name":"Socure Payment Screening - Source (Individual)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"individual","firstName":"Emily","surName":"Chen","entityName":"Emily Chen","dob":"1988-04-12","physicalAddress":"4521 Westwood Blvd","city":"Los Angeles","state":"CA","zip":"90064","country":"US"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-src-ind-5e6a3934"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Source (Business)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"organization","entityName":"Tech Innovators LLC","mobileNumber":"+18005556789","physicalAddress":"456 Innovation Drive","physicalAddress2":"Floor 5","city":"Mountain View","state":"CA","zip":"94043","country":"US","cryptoAddress":"18uKfaUjgG52rVeXEi3wxnveww7zZuECtE","cryptoNetwork":"XBT"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-src-biz-19af2c11"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Source (Individual Account)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"organization","entityName":"Chase","physicalAddress":"200 Key Square St","physicalAddress2":"New York","city":"New York City","state":"NY","zip":"12345","country":"US","bankIdentifierCode":"CH-123","internationalBankAccountNumber":"FR1420041010050500013M02606"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-src-indacct-83bb01d2"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Source (Business Account)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"organization","entityName":"Chase","physicalAddress":"200 Key Square St","physicalAddress2":"New York","city":"New York City","state":"NY","zip":"12345","country":"US","bankIdentifierCode":"CH-123","internationalBankAccountNumber":"FR1420041010050500013M02606"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-src-bizacct-2a1c9e77"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Destination (Individual)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"individual","firstName":"Andrey","surName":"Kostin","entityName":"Andrey Kostin","dob":"1956-09-21","physicalAddress":"29 Degtyarny Pereulok","city":"Moscow","zip":"127994","country":"RU"},"response":{"globalWatchlist":{"matches":{"OFAC SDN List":[{"matchScore":100,"listingId":"OFAC-24063","program":"UKRAINE-EO13661","sourceCode":"OFAC"}]},"reasonCodes":["R173","R186","R180"]},"referenceId":"ref-dst-ind-3fbb2e10"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Destination (Business)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"organization","entityName":"Tech Innovators LLC","mobileNumber":"+18005556789","physicalAddress":"456 Innovation Drive","physicalAddress2":"Floor 5","city":"Mountain View","state":"CA","zip":"94043","country":"US","cryptoAddress":"18uKfaUjgG52rVeXEi3wxnveww7zZuECtE","cryptoNetwork":"XBT","nationalId":"12-3456789"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-dst-biz-7c4d5e88"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Destination (Individual Account)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"organization","entityName":"Chase","physicalAddress":"200 Key Square St","physicalAddress2":"New York","city":"New York City","state":"NY","zip":"12345","country":"US","bankIdentifierCode":"CH-123","internationalBankAccountNumber":"FR1420041010050500013M02606"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-dst-indacct-9a1b2c33"},"is_source_cache":false,"total_attempts":1},{"enrichment_name":"Socure Payment Screening - Destination (Business Account)","enrichment_provider":"SocurePaymentScreening","enrichment_endpoint":"https://service.socure.com/api/3.0/EmailAuthScore","status_code":200,"request":{"entityType":"organization","entityName":"Chase","physicalAddress":"200 Key Square St","physicalAddress2":"New York","city":"New York City","state":"NY","zip":"12345","country":"US","bankIdentifierCode":"CH-123","internationalBankAccountNumber":"FR1420041010050500013M02606"},"response":{"globalWatchlist":{"matches":{},"reasonCodes":["I196"]},"referenceId":"ref-dst-bizacct-4e5f6a77"},"is_source_cache":false,"total_attempts":1}],"eval_status":"evaluation_completed","environment_name":"Production"}},"AgeAssuranceResponse":{"description":"Age Assurance","value":{"id":"test-user-phone","eval_id":"7e79e169-5021-475b-af98-9362ac690c38","workflow":"age_assurance","eval_status":"evaluation_completed","decision":"ACCEPT","status":"CLOSED","sub_status":"Accept","workflow_id":"5b1399aa-c4b9-4f70-90ee-170e6f3cdc55","workflow_version":"3.7.0","eval_source":"API","eval_start_time":"2026-07-07T12:44:22.100Z","eval_end_time":"2026-07-07T12:44:23.512Z","tags":["Valid Age"],"review_queues":[],"computed":{"socure_age_assurance_response":{"age18Plus":true,"age21Plus":true,"age25Plus":false,"entityKind":"phone","isSuccess":true,"refId":"789a83ce-8b28-4239-8a7c-20e1a8ba0b5a","uniqueCnt":96}}}},"PatchUpdateEmail":{"summary":"Consumer Onboarding: Update Email Address","value":{"id":"onb-12345","timestamp":"2023-12-01T08:15:30.456Z","workflow":"consumer_onboarding","data":{"individual":{"email":"updated.email@example.com"}}}},"PatchUpdatePhone":{"summary":"Consumer Onboarding: Update Phone Number","value":{"id":"onb-12345","timestamp":"2023-12-01T08:15:30.456Z","workflow":"consumer_onboarding","data":{"individual":{"phone_number":"+1-202-555-9999"}}}},"PatchUpdateDevice":{"summary":"Consumer Onboarding: Update Device Information","value":{"id":"onb-12345","timestamp":"2023-12-01T08:15:30.456Z","workflow":"consumer_onboarding","data":{"external_device":{"id":"DEVICE-123456","ip_address":"192.168.1.10","session":"UPDATED-SESSION-1234"}}}},"PatchTrustAndSafety":{"summary":"Trust and Safety: Update Email Address","value":{"id":"ts-89012","timestamp":"2023-12-01T18:24:10.234Z","workflow":"trust_and_safety","data":{"event_type":"consumer_verification","event_category":"verification","individual":{"email":"updated.email@example.com"}}}},"PatchLoginAndAuthentication":{"summary":"Login and Authentication: Submit OTP Code","value":{"id":"ato-78901","timestamp":"2023-12-01T15:47:05.123Z","workflow":"account_takeover","data":{"event_type":"address_update","event_category":"update","individual":{"otp":{"code":"123456"}}}}},"PatchAdvancedPrefill":{"summary":"Advanced Prefill: Submit OTP Code","value":{"id":"advanced-prefill-03f1de","timestamp":"2026-04-02T12:01:00Z","workflow":"advanced_pre_fill","data":{"individual":{"phone_number":"16673681976","di_session_token":"YOUR_DI_SESSION_TOKEN","otp":{"code":"123456"}}}}},"PatchGenericPassthrough":{"summary":"Generic Passthrough: Update Email Address","value":{"id":"genr-12345","timestamp":"2023-12-01T08:20:30.456Z","workflow":"generic_passthrough","data":{"individual":{"email":"updated.email@example.com"}}}},"PatchBankAccountVerification":{"summary":"Bank Account Verification: Update Email Address","value":{"id":"BAV-REQ-123456","timestamp":"2022-09-01T12:39:56.789Z","workflow":"bank_account_verification","data":{"individual":{"email":"updated.email@example.com"}}}},"PatchBusinessOnboarding":{"summary":"Business Onboarding: Update Email Address","value":{"id":"onb-biz-56789","timestamp":"2023-12-01T10:35:25.789Z","workflow":"business_onboarding","data":{"individual":{"email":"updated.email@example.com"}}}},"PatchWorkforceVerification":{"summary":"Workforce Verification: Update Email Address","value":{"id":"a86580cc-1733-4188-86b5-717166e1db8c","workflow":"trust_and_safety","timestamp":"2025-05-02T12:49:22.059Z","data":{"event_type":"application_submitted","event_category":"workforce_verification","individual":{"id":"09237776-f16b-4eec-9305-fc425843d887","given_name":"John","family_name":"Smith","email":"updated.email@example.com","phone_number":"1-310-841-6189","address":{"line_1":"123 Main Street","locality":"New York","major_admin_division":"NY","country":"US","postal_code":"10001"},"di_session_token":"eyJraWQiOiJmMzRiN2YiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.DI_LOW_SCORE"}}}},"PatchPaymentScreening":{"summary":"Payment Screening: Update Destination Individual","value":{"workflow":"payment_screening","id":"txn-007341829056","timestamp":"2026-05-19T14:27:03.000Z","data":{"transaction_type":"transfer","destination":{"amount":24500,"currency":"USD","individual":{"id":"dst-ind-001","given_name":"Andrey","family_name":"Kostin","date_of_birth":"1956-09-21"}}}}},"PatchAgeAssurance":{"summary":"Age Assurance: Update Email Address","value":{"id":"test-user-phone","timestamp":"2026-07-07T12:49:22.059Z","workflow":"age_assurance","data":{"individual":{"email":"updated.email@example.com"}}}}}},"x-readme":{"explorer-enabled":false,"samples-languages":["shell","java","python","node","go"],"parameter-ordering":["path","query","header","body","cookie","form"],"x-tagGroups":[{"name":"Core Risk Evaluation","tags":["Evaluation","Feedback","Outcome"]},{"name":"Watchlist","tags":["Custom Watchlist"]},{"name":"Reference Data","tags":["Reason Codes"]}]}}