Alloy SDK Example Vanilla

### Alloy SDK Quick Start Example (Embedded JS) Source: https://developer.alloy.com/public/docs/sdk-installation A complete HTML example demonstrating how to embed the Alloy SDK, initialize it, and open the SDK modal with a callback function. This example is for vanilla JavaScript environments. ```html Alloy SDK Example Vanilla

``` -------------------------------- ### Alloy SDK Quick Start Example (NPM/React) Source: https://developer.alloy.com/public/docs/sdk-installation A React component example demonstrating how to integrate the Alloy SDK using the NPM package. It shows initialization, opening the SDK with different anchor points, and closing it. ```typescript import React from 'react'; import alloy from '@alloyidentity/web-sdk'; import './App.css'; // Declare your SDK parameters const alloyInitParams = { key: 'xyz', journeyApplicationToken: 'JA-xyz', journeyToken: 'J-XYZ' }; // Initialize the Alloy SDK alloy.init(alloyInitParams); function App() { // // This is a sample callback function. This function can be passed into the open function, and will be exectuted when the SDK closes const callback = data => { console.log(data); }; const onOpen = () => { const anchorElementSelected = document.getElementById('anchors'); const anchorElement = anchorElementSelected.options[anchorElementSelected.selectedIndex].value; // Open the SDK. The "open" function allows the use of an optional parameter to mount the alloy modal inside a div identified by its ID or class name. // If not specified, it'll be absolute positioned in the middle of the document. alloy.open(callback, anchorElement); }; const onClose = () => { alloy.close(); }; return ( <>

(ID: anchor1)

(className: anchor2)

(className: anchor3)

); } export default App; ``` -------------------------------- ### Run Portfolio Evaluation POST Request Example Source: https://developer.alloy.com/public/reference/post_portfolio-evaluations Example of a POST request to the /portfolio-evaluations endpoint. This request initiates a portfolio evaluation using the 'adhoc' source. ```json { "source": "adhoc" } ``` -------------------------------- ### Install Alloy Web SDK Source: https://developer.alloy.com/public/docs/biocatch-integration Installs the Alloy Web SDK using npm. This is the first step to using the SDK in your project. ```bash npm install @alloyidentity/web-sdk ``` -------------------------------- ### Get Case by Token Source: https://developer.alloy.com/public/reference/get_cases-case-token-2 Retrieves a single case using its unique case token. Case tokens are alphanumeric and start with 'C-'. ```APIDOC ## GET /cases/{case_token} ### Description Retrieves a single case uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". ### Method GET ### Endpoint /cases/{case_token} ### Parameters #### Path Parameters - **case_token** (string) - Required - Token of case to get. ### Response #### Success Response (200) - **_embedded** (object) - Contains the case details. #### Response Example ```json { "_embedded": { "cases": [ { "case_token": "C-12345", "entity_id": "ent_abc123", "type": "identity_verification", "created_at": "2023-10-27T10:00:00Z", "closed_at": null, "tags": [], "notes": "Initial review required.", "entity": { "entity_token": "ent_abc123", "type": "individual", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com" } } ] } } ``` ``` -------------------------------- ### Start Application Source: https://developer.alloy.com/public/docs/onboarding-with-step-up-journey Initiates a new application by making a POST request to the journeys endpoint. ```APIDOC ## POST /journeys-journey-token-applications ### Description Starts a new application by making a POST request to the journeys endpoint. ### Method POST ### Endpoint https://developer.alloy.com/public/reference/post_journeys-journey-token-applications ### Parameters #### Query Parameters None #### Request Body None specified ### Request Example ```json { "example": "No request body example provided" } ``` ### Response #### Success Response (200) - **status** (string) - The status of the application. - **token** (string) - The unique token for the application. #### Response Example ```json { "example": "{\"status\": \"running\", \"token\": \"some_application_token\"}" } ``` ``` -------------------------------- ### Example Custom Model Payload (JSON) Source: https://developer.alloy.com/public/reference/get-custom-model-payload This is an example of the JSON payload that might be returned for a historical evaluation. It includes a list of attributes with their names and values, as supplied to the custom model. ```json { "Alloy Data Supplied": [ { "attributeName": "name_first", "attributeValue": "false" }, { "attributeName": "name_last", "attributeValue": "false" }, { "attributeName": "birth_date", "attributeValue": "false" } ] } ``` -------------------------------- ### Custom Model Endpoint Setup Source: https://developer.alloy.com/public/docs/customer-hosted-models Details on setting up a publicly available web server for custom models, including HTTPS requirements and authorization methods. ```APIDOC ## Web-server and public endpoint URL ### Description You need to host a publicly available web server that can process JSON over HTTPS. For security, the server must use HTTPS to ensure all private information is encrypted end-to-end. ### Authorization The custom models service supports HTTP Basic Auth on your endpoint. You can configure `username` and `password` credentials for your custom model in your organization’s [settings page](https://app.alloy.co/settings/?page=services). If you are using multiple custom models, they will all share the same credentials. Therefore, all of your custom model endpoints must accept the same Basic Auth `username` and `password`. ### Custom Model ID's After setting up your custom model endpoint, contact your Alloy Solutions Architect with the endpoint URL. They will configure the custom model in our system and provide you with a custom model ID. ### Custom Model Versioning To test successive versions of your custom model, you can provide unique URLs to Alloy that invoke specific versions of your custom model. Alloy will then provide custom model IDs for each endpoint, allowing you to test different versions of your model within Workflow and Journey versions using Alloy's various testing tools. ``` -------------------------------- ### Get Case Evidences Source: https://developer.alloy.com/public/reference/get_cases-case-token-evidences-2 Retrieves a list of case evidences uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". ```APIDOC ## GET /cases/{case_token}/evidences ### Description Retrieves a list of case evidences uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". ### Method GET ### Endpoint /cases/{case_token}/evidences ### Parameters #### Path Parameters - **case_token** (string) - Required - Token of case to get evidence for. ### Response #### Success Response (200) - **status_code** (number) - The HTTP status code of the response. - **error** (string) - An error message if the request failed. - **_embedded** (object) - Contains the list of evidences. - **evidences** (array) - A list of case evidences. - **created_at** (number) - A Unix timestamp, representing when the evidence was created in Alloy's internal system. - **occurred_at** (number) - A Unix timestamp, representing when the evidence occurred. For example, this could be a transaction timestamp. - **transaction_id** (string) - A nullable string, representing the identifier for transaction linked to a case. - **evaluation_token** (string) - A nullable string, representing the evaluation token linked to an evidence. - **is_manual** (boolean) - Indication of if the evidence was added manually by a user. - **is_portfolio_eval** (boolean) - Indicates if the evidence is part of a portfolio evaluation. - **portfolio_evaluation_token** (string) - A nullable string, representing the portfolio evaluation token linked to an evidence. - **alerts** (array) - The alert(s) that were added as part of this evidence. #### Response Example ```json { "status_code": 200, "error": null, "_embedded": { "evidences": [ { "created_at": 1678886400, "occurred_at": 1678886300, "transaction_id": "txn_12345", "evaluation_token": "eval_abcde", "is_manual": false, "is_portfolio_eval": false, "portfolio_evaluation_token": null, "alerts": [ { "alert_type": "High Risk", "details": "Potential fraud detected." } ] } ] } } ``` ``` -------------------------------- ### Login Event Request Example (JSON) Source: https://developer.alloy.com/public/docs/event-types-login This JSON object represents an example request for a login event. It includes details such as the event type, status, timestamp, entity identifiers, username, login method, and device information. ```json { "event_type": "login", "event_status": "attempted", "event_lifecycle_id": "MJ-CO-427kjfs", "data": { "timestamp": "2024-03-25T23:50:34.681Z", "external_login_id": "MJ-CO-427kjfs", "external_entity_id": "9e82d5e7-ada0-4957-a8fd-4d937c99bae8", "username": "John.Doe84", "status": "attempted", "login_method": "password", "sso": null, "device": { "ip_address_v4": "88.232.60.238", "device_type": "mobile" }, "meta": { "foo": "bar" }, "supplemental_data": {} } } ``` -------------------------------- ### Get Case Evidences by Case Token Source: https://developer.alloy.com/public/reference/get_cases-case-token-evidences-2 Retrieves a list of case evidences uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". ```APIDOC ## GET /websites/developer_alloy_public/case_evidences ### Description Retrieves a list of case evidences uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". ### Method GET ### Endpoint /websites/developer_alloy_public/case_evidences ### Parameters #### Query Parameters - **case_token** (string) - Required - The unique alphanumeric token for the case, starting with "C-". ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **evidences** (array) - A list of case evidence objects. - **evidence_id** (string) - The unique identifier for the evidence. - **type** (string) - The type of evidence (e.g., "document", "image"). - **url** (string) - The URL to access the evidence. - **uploaded_at** (string) - The timestamp when the evidence was uploaded. #### Response Example ```json { "evidences": [ { "evidence_id": "EVID-12345", "type": "document", "url": "https://example.com/evidences/doc123.pdf", "uploaded_at": "2023-10-27T10:00:00Z" }, { "evidence_id": "EVID-67890", "type": "image", "url": "https://example.com/evidences/img456.jpg", "uploaded_at": "2023-10-27T10:05:00Z" } ] } ``` ``` -------------------------------- ### Example Success JSON Output Source: https://developer.alloy.com/public/docs/customer-hosted-models Illustrates the expected JSON response format for a successful custom model execution. This includes a success flag, a model score, and optionally, version information and additional data. ```json { "modelSuccess": true, "modelScore": 0.95, "modelVersion": 1.2, "prediction": "approved" } ``` -------------------------------- ### Get Bank Account by Token or Identifier Source: https://developer.alloy.com/public/reference/get_bank-accounts-account-identifier-or-token Retrieves a single bank account uniquely defined by a bank account token or external account identifier. Bank account tokens are alphanumeric characters that start with a prefix "A-". External account identifiers are strings provided by services or clients. ```APIDOC ## GET /websites/developer_alloy_public ### Description Retrieves a single bank account uniquely defined by a bank account token or external account identifier. Bank account tokens are alphanumeric characters that start with a prefix "A-". External account identifiers are strings provided by services or clients. ### Method GET ### Endpoint /websites/developer_alloy_public ### Parameters #### Query Parameters - **token** (string) - Required - The unique bank account token (starts with "A-"). - **external_account_id** (string) - Required - The external account identifier provided by the client or service. ### Request Example ``` GET /websites/developer_alloy_public?token=A-123abcXYZ ``` OR ``` GET /websites/developer_alloy_public?external_account_id=client-ref-456 ``` ### Response #### Success Response (200) - **account_details** (object) - Contains historical and entity data for the bank account. - **account_number** (string) - The bank account number. - **routing_number** (string) - The bank routing number. - **account_type** (string) - The type of bank account (e.g., checking, savings). - **owner_name** (string) - The name of the account owner. - **historical_data** (array) - An array of historical transactions or balance information. - **entity_data** (object) - Information about the entity associated with the account. #### Response Example ```json { "account_details": { "account_number": "1234567890", "routing_number": "012345678", "account_type": "checking", "owner_name": "John Doe", "historical_data": [ { "date": "2023-10-26", "description": "Initial Deposit", "amount": 1000.00 } ], "entity_data": { "entity_id": "ent_xyz789", "name": "Example Corp" } } } ``` ``` -------------------------------- ### OpenAPI Definition for Get An Evaluation Source: https://developer.alloy.com/public/reference/get_entities-entity-token-evaluations-evaluation-token-2 This OpenAPI 3.0.0 definition specifies the 'Get An Evaluation' endpoint. It includes details on the server URL, security schemes (OAuth2 and Basic), parameters (entity_token, evaluation_token), and the GET request method with its responses. ```json { "openapi": "3.0.0", "info": { "title": "Alloy API", "version": "1.0.0", "description": "hey hey hey, it's the Alloy API!" }, "servers": [ { "url": "https://sandbox.alloy.co/v1", "description": "Sandbox endpoint" } ], "security": [ { "oauth2": [] }, { "basic": [] } ], "components": { "securitySchemes": { "basic": { "type": "http", "description": "HTTP basic authorization using a workflow token and secret", "scheme": "basic" }, "oauth2": { "type": "oauth2", "description": "Oauth2 using a workflow token and secret to generate a bearer token", "flows": { "clientCredentials": { "tokenUrl": "/oauth/bearer", "scopes": {} } } } } }, "tags": [ { "name": "Entities", "description": "Entities are the center of the Alloy world. All evaluations, manual reviews, and documents are related to an entity whether or not you explicitly link them together in your API requests. This endpoint provides the ability to query on an entity and get top-level details about that entity as well as an overview of all items associated with the entity. The tokens from linked evaluations, reviews, or documents can be passed to their own API endpoints for more information about those specific items." } ], "paths": { "/entities/{entity_token}/evaluations/{evaluation_token}": { "parameters": [ { "in": "path", "name": "entity_token", "schema": { "type": "string" }, "required": true, "description": "Token associated with entity." }, { "in": "path", "name": "evaluation_token", "schema": { "type": "string" }, "required": true, "description": "Token associated with evaluation." } ], "get": { "tags": [ "Entities" ], "summary": "Get An Evaluation", "description": "If you want to look up the result of a previously-run evaluation, you can use the API to get the exact same response that was returned from POST /evaluations originally. Here is the endpoint for getting that information.", "responses": { "200": { "x-summary": "OK", "description": "Entity", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/paths/~1evaluations/post/responses/201/content/application~1json/schema" } } } } } } } } } ``` -------------------------------- ### GET /entity-feedback Source: https://developer.alloy.com/public/reference/get_entity-feedback Retrieves a list of entity feedback. This endpoint allows you to get information about the status of an entity after account opening. ```APIDOC ## GET /entity-feedback ### Description Get a list of entity feedback. This endpoint provides information about the status of an entity post account opening. ### Method GET ### Endpoint /entity-feedback ### Parameters #### Query Parameters * **entity_id** (integer) - Required - The ID of the entity to retrieve feedback for. * **entity_feedback_id** (integer) - Optional - The ID of a specific entity feedback record. * **entity_feedback_status_id** (integer) - Optional - Filter feedback by status ID. * **feedback_case_status_id** (integer) - Optional - Filter feedback by case status ID. * **feedback_fraud_type_id** (integer) - Optional - Filter feedback by fraud type ID. * **feedback_fraud_channel_id** (integer) - Optional - Filter feedback by fraud channel ID. * **feedback_case_reason_id** (integer) - Optional - Filter feedback by case reason ID. * **created_after** (string) - Optional - Filter feedback created after a specific date (ISO 8601 format). * **created_before** (string) - Optional - Filter feedback created before a specific date (ISO 8601 format). * **limit** (integer) - Optional - The maximum number of results to return. * **offset** (integer) - Optional - The number of results to skip. ### Request Example ```json { "example": "GET /entity-feedback?entity_id=2515720" } ``` ### Response #### Success Response (200) - **status_code** (number) - The HTTP status code of the response. - **error** (object) - An object containing error details if an error occurred, otherwise null. - **timestamp** (integer) - The timestamp when the request was processed. - **name** (string) - The name of the data object, typically "EntityFeedback". - **data** (object) - An object containing the entity feedback data. - **inserted_entity_feedback** (array) - A list of successfully retrieved entity feedback records. - **created_at** (string) - The creation timestamp of the feedback. - **entity_feedback_id** (integer) - The unique identifier for the entity feedback. - **entity_id** (integer) - The ID of the entity associated with the feedback. - **exposure_amount** (number) - The exposure amount related to the feedback. - **feedback_case_reason_id** (integer) - The ID of the case reason for the feedback. - **feedback_case_status_id** (integer) - The ID of the case status for the feedback. - **feedback_entity_status_id** (integer) - The ID of the entity status for the feedback. - **feedback_fraud_channel_id** (integer) - The ID of the fraud channel for the feedback. - **feedback_fraud_type_id** (integer) - The ID of the fraud type for the feedback. - **loss_amount** (number) - The loss amount related to the feedback. - **invalid_entity_feedback** (array) - A list of entity feedback records that were invalid or could not be processed. #### Response Example ```json { "status_code": 201, "error": null, "timestamp": 1557675468774, "name": "EntityFeedback", "data": { "inserted_entity_feedback": [ { "created_at": "2024-01-31T21:27:46.864Z", "entity_feedback_id": 34, "entity_id": 2515720, "exposure_amount": 500, "feedback_case_reason_id": 2, "feedback_case_status_id": null, "feedback_entity_status_id": null, "feedback_fraud_channel_id": null, "feedback_fraud_type_id": null, "loss_amount": 500 } ], "invalid_entity_feedback": [] } } ``` ``` -------------------------------- ### Initialize Alloy SDK with Configuration Source: https://developer.alloy.com/public/docs/alloy-sdk-functions The `init` function sets up the Alloy SDK with essential configurations. It requires a `key`, `journeyApplicationToken`, `journeyToken`, and `production` flag. Optional parameters allow for customization of API URLs, UI elements, and platform-specific settings. This function is crucial for the SDK's operation. ```javascript alloy.init({ key: "ecfb58b7-a611-4fbd-b727-1b1d2113411a", production: false, journeyApplicationToken: "JA-hlZa11yUJYkTNzUTl116", journeyToken:"J-YCMHdHquF111111eM9" }); ``` -------------------------------- ### POST /websites/developer_alloy_public/lists Source: https://developer.alloy.com/public/reference/post_lists Creates a new list within the specified project. Requires metadata for the list. ```APIDOC ## POST /websites/developer_alloy_public/lists ### Description Creates a new list with input metadata. ### Method POST ### Endpoint /websites/developer_alloy_public/lists ### Parameters #### Request Body - **metadata** (object) - Required - The metadata for the new list. - **name** (string) - Required - The name of the list. - **description** (string) - Optional - A description for the list. ### Request Example ```json { "metadata": { "name": "My New List", "description": "This is a list of important items." } } ``` ### Response #### Success Response (201) - **id** (string) - The unique identifier for the newly created list. - **name** (string) - The name of the list. - **description** (string) - The description of the list. - **createdAt** (string) - The timestamp when the list was created. #### Response Example ```json { "id": "list-12345", "name": "My New List", "description": "This is a list of important items.", "createdAt": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### Started Mid-Journey Reconciliation Source: https://developer.alloy.com/public/docs/journey-events This event signifies the start of a mid-Journey Reconciliation Workflow Evaluation. This is not a mandatory node for all Journeys. ```APIDOC ## Started Mid-Journey Reconciliation ### Description A mid-Journey Reconciliation Workflow Evaluation has been started. This is not a mandatory node for all Journeys. ### Method POST ### Endpoint /v1/journey-events ### Parameters #### Query Parameters - **type** (string) - Required - The event type, should be `started_mid_journey_reconciliation`. #### Request Body - **journey_application_event_token** (string) - Required - The unique token for the journey application event. - **journey_application_token** (string) - Required - The token of the journey application. - **type** (string) - Required - The type of the event, `started_mid_journey_reconciliation`. - **journey_type** (string) - Required - The type of the journey (e.g., `application`). - **timestamp** (integer) - Required - The Unix timestamp when the event occurred. - **entity_token** (string) - Required - The token of the entity. - **entity_application_token** (string) - Optional - The token of the entity application. - **_embedded** (object) - Required - Embedded data related to the node. - **node** (object) - Required - Information about the started node. - **id** (string) - Required - The unique identifier of the node. - **name** (string) - Required - The name of the node. - **type** (string) - Required - The type of the node (e.g., `reconciliation_workflow`). - **config** (object) - Required - Configuration details for the node. - **application_token** (string) - Required - The token of the application. - **workflow_token** (string) - Required - The token of the workflow. - **application_version_id** (integer) - Required - The version ID of the application. - **workflow_version_id** (integer) - Required - The version ID of the workflow. - **workflow_type** (string) - Required - The type of the workflow (e.g., `reconciliation`). - **workflow_current_version** (integer) - Required - The current version of the workflow. - **workflow_name** (string) - Required - The name of the workflow. - **_links** (object) - Required - Links related to the event. ### Request Example ```json { "journey_application_event_token": "116712752", "journey_application_token": "JA-NlqG55XmEIIkkxLCNMuC", "type": "started_mid_journey_reconciliation", "journey_type": "application", "timestamp": 1719342638831, "entity_token": "G-apCevjm5sTtpgcx90qJQ", "entity_application_token": null, "_embedded": { "node": { "id": "7b4929c6-01be-48dd-a10b-913085b61635", "name": "Mid-Journey Recon", "type": "reconciliation_workflow", "config": { "application_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs", "workflow_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs", "application_version_id": 0, "workflow_version_id": 0, "workflow_type": "reconciliation", "workflow_current_version": 11 }, "workflow_name": "Mid-Journey Recon" } }, "_links": {} } ``` ### Response #### Success Response (200) - **journey_application_event_token** (string) - The token of the created journey application event. - **journey_application_token** (string) - The token of the journey application. - **type** (string) - The type of the event. - **journey_type** (string) - The type of the journey. - **timestamp** (integer) - The timestamp of the event. - **entity_token** (string) - The token of the entity. - **entity_application_token** (string) - The token of the entity application. - **_embedded** (object) - Embedded data related to the node. - **node** (object) - Information about the node. - **id** (string) - The unique identifier of the node. - **name** (string) - The name of the node. - **type** (string) - The type of the node. - **config** (object) - Configuration details for the node. - **application_token** (string) - The token of the application. - **workflow_token** (string) - The token of the workflow. - **application_version_id** (integer) - The version ID of the application. - **workflow_version_id** (integer) - The version ID of the workflow. - **workflow_type** (string) - The type of the workflow. - **workflow_current_version** (integer) - The current version of the workflow. - **workflow_name** (string) - The name of the workflow. - **_links** (object) - Links related to the event. #### Response Example ```json { "journey_application_event_token": "116712752", "journey_application_token": "JA-NlqG55XmEIIkkxLCNMuC", "type": "started_mid_journey_reconciliation", "journey_type": "application", "timestamp": 1719342638831, "entity_token": "G-apCevjm5sTtpgcx90qJQ", "entity_application_token": null, "_embedded": { "node": { "id": "7b4929c6-01be-48dd-a10b-913085b61635", "name": "Mid-Journey Recon", "type": "reconciliation_workflow", "config": { "application_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs", "workflow_token": "iOQyQ5gqOhZFKfhZCO44SKvi8GyPipbs", "application_version_id": 0, "workflow_version_id": 0, "workflow_type": "reconciliation", "workflow_current_version": 11 }, "workflow_name": "Mid-Journey Recon" } }, "_links": {} } ``` ``` -------------------------------- ### Get Journey Applications (GET /journeys/entities/{external_entity_id}/applications) Source: https://developer.alloy.com/public/reference/get_journeys-entities-external-entity-id-applications Retrieves a list of Journey Applications associated with a given Alloy Entity Token or External Entity ID. This GET request requires the entity ID in the path and returns a JSON array of journey application objects. Authentication is handled via OAuth2 or Basic HTTP authentication. ```json { "openapi": "3.0.0", "info": { "title": "Alloy API", "version": "1.0.0", "description": "hey hey hey, it's the Alloy API!" }, "servers": [ { "url": "https://sandbox.alloy.co/v1", "description": "Sandbox endpoint" } ], "security": [ { "oauth2": [] }, { "basic": [] } ], "components": { "securitySchemes": { "basic": { "type": "http", "description": "HTTP basic authorization using a workflow token and secret", "scheme": "basic" }, "oauth2": { "type": "oauth2", "description": "Oauth2 using a workflow token and secret to generate a bearer token", "flows": { "clientCredentials": { "tokenUrl": "/oauth/bearer", "scopes": {} } } } } }, "tags": [ { "name": "Journeys", "description": "A Journey is a decision configuration that allows you to run multiple workflows." } ], "paths": { "/journeys/entities/{external_entity_id}/applications": { "parameters": [ { "in": "path", "name": "external_entity_id", "schema": { "type": "string" }, "required": true, "description": "Alloy Entity Token or External identifier of the entity", "example": "Alloy Token: P-xdO81d1VUsMwGk4zRl6J\n\nExternal Entity Token: MJ929-X433JX-EK\n" } ], "get": { "tags": [ "Journeys" ], "summary": "Get Journey Applications by Alloy Entity Token or External Entity ID.", "description": "This endpoint retrieves a list of Journey Applications associated with the supplied Alloy Entity Token or an External Entity ID.\n", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "journey_application_token": { "type": "string", "example": "JA-HVgmPEnrtWpnMTSfE5zm" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-06-10T13:30:31.352Z" }, "journey_token": { "type": "string", "example": "J-dT8zCu7TQo5tfXzSgrBY" }, "journey_name": { "type": "string", "example": "Name of the Journey Processed" }, "journey_version": { "type": "string", "example": "16" }, "journey_type": { "type": "string", "example": "application" }, "evaluation_tokens": { "type": "array", "items": { "type": "string" }, "example": [ "S-SPchW8E20YJj0nkpYqvS" ] } }, "description": "A summary of a journey application." } } } } }, "401": { "$ref": "#/paths/~1journeys~1%7Bjourney_token%7D~1schema/get/responses/401" }, "404": { "$ref": "#/paths/~1journeys~1%7Bjourney_token%7D~1schema/get/responses/404" }, "429": { "$ref": "#/paths/~1journeys~1%7Bjourney_token%7D~1schema/get/responses/429" }, "500": { "$ref": "#/paths/~1journeys~1%7Bjourney_token%7D~1schema/get/responses/500" }, "503": { "$ref": "#/paths/~1journeys~1%7Bjourney_token%7D~1schema/get/responses/503" } } } } } } ``` -------------------------------- ### Run Portfolio Evaluation POST Response Example (201 Created) Source: https://developer.alloy.com/public/reference/post_portfolio-evaluations Example of a successful response (201 Created) after running a portfolio evaluation. It includes a unique token for the evaluation and its initial status. ```json { "portfolio_evaluation_token": "PE-54321", "status": "pending" } ``` -------------------------------- ### Get Entity Feedback OpenAPI Definition Source: https://developer.alloy.com/public/reference/get_entity-feedback The OpenAPI 3.0.0 definition for the Alloy API's 'Get entity feedback' endpoint. It outlines the request method, parameters, and response structure, including authentication methods like OAuth2 and Basic auth. ```json { "openapi": "3.0.0", "info": { "title": "Alloy API", "version": "1.0.0", "description": "hey hey hey, it's the Alloy API!" }, "servers": [ { "url": "https://sandbox.alloy.co/v1", "description": "Sandbox endpoint" } ], "security": [ { "oauth2": [] }, { "basic": [] } ], "components": { "securitySchemes": { "basic": { "type": "http", "description": "HTTP basic authorization using a workflow token and secret", "scheme": "basic" }, "oauth2": { "type": "oauth2", "description": "Oauth2 using a workflow token and secret to generate a bearer token", "flows": { "clientCredentials": { "tokenUrl": "/oauth/bearer", "scopes": {} } } } } }, "tags": [ { "name": "Entity Feedback", "description": "Entity feedback data is information about the status of an entity post account opening." } ], "paths": { "/entity-feedback": { "get": { "tags": [ "Entity Feedback" ], "summary": "Get entity feedback", "description": "Get a list of entity feedback", "responses": { "200": { "description": "Successfully inserted entity feedback", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number" }, "error": { "type": "object" }, "timestamp": { "type": "integer" }, "name": { "type": "string" }, "data": { "type": "object" } } }, "example": { "status_code": 201, "error": null, "timestamp": 1557675468774, "name": "EntityFeedback", "data": { "inserted_entity_feedback": [ { "created_at": "2024-01-31T21:27:46.864Z", "entity_feedback_id": 34, "entity_id": 2515720, "exposure_amount": 500, "feedback_case_reason_id": 2, "feedback_case_status_id": null, "feedback_entity_status_id": null, "feedback_fraud_channel_id": null, "feedback_fraud_type_id": null, "loss_amount": 500 } ], "invalid_entity_feedback": [] } } } } } } } } } } ```