# alloy-public Documentation > Documentation for alloy-public ## Guides - [Welcome to Alloy](https://developer.alloy.com/public/docs/introduction.md): Explore our product guides and API reference to help with your integration process. - [Account-Level API Keys](https://developer.alloy.com/public/docs/account-level-api-keys.md) - [Authentication Guide](https://developer.alloy.com/public/docs/authentication-guide.md) - [Sandbox vs. Production](https://developer.alloy.com/public/docs/sandbox-vs-production.md) - [How to Configure SAML SSO](https://developer.alloy.com/public/docs/how-to-configure-saml-single-sign-on-sso-with-alloy.md) - [Generic SAML 2.0](https://developer.alloy.com/public/docs/generic-saml-20.md) - [Okta](https://developer.alloy.com/public/docs/okta.md) - [Azure](https://developer.alloy.com/public/docs/azure.md) - [Microsoft ADFS](https://developer.alloy.com/public/docs/microsoft-adfs.md) - [JumpCloud](https://developer.alloy.com/public/docs/jumpcloud.md) - [How to Configure SCIM](https://developer.alloy.com/public/docs/how-to-configure-scim-system-for-cross-domain-identity-management-with-alloy.md) - [Okta](https://developer.alloy.com/public/docs/scim-with-okta.md): This is a comprehensive step-step guide to set up SCIM with Okta - [Azure](https://developer.alloy.com/public/docs/scim-with-azure.md) - [Introduction to Onboarding](https://developer.alloy.com/public/docs/introduction-to-onboarding.md) - [Onboarding with Entity Groups](https://developer.alloy.com/public/docs/onboarding-with-entity-groups.md): This use case will provide an overview of Entity Groups and how to provide Entity Group information to the Journeys API. - [Ongoing Monitoring with Entity Groups](https://developer.alloy.com/public/docs/ongoing-monitoring-with-entity-groups.md) - [Introduction](https://developer.alloy.com/public/docs/intro-to-entities.md) - [External Entity ID Best Practices ](https://developer.alloy.com/public/docs/external-entity-id-best-practices.md): How to choose the right Entity identifier for your Alloy integration. - [Retroactively Assigning an External Entity ID](https://developer.alloy.com/public/docs/assigning-an-external-entity-id-later.md) - [Multiple External Entity IDs](https://developer.alloy.com/public/docs/multiple-external-entity-ids.md) - [Entity Merging](https://developer.alloy.com/public/docs/entity-merging.md) - [Journey Application Use Cases](https://developer.alloy.com/public/docs/entities-journey-applications.md) - [Evaluation Use Cases](https://developer.alloy.com/public/docs/entities-evaluations.md) - [Overview](https://developer.alloy.com/public/docs/journeys-overview.md): Understanding Journey Applications - [Statuses and Outcomes](https://developer.alloy.com/public/docs/statuses-and-outcomes.md) - [Multi-Entity Applications](https://developer.alloy.com/public/docs/multi-entity-applications.md) - [Action Nodes](https://developer.alloy.com/public/docs/action-nodes.md) - [Step Up Nodes](https://developer.alloy.com/public/docs/step-up-nodes.md) - [Integration](https://developer.alloy.com/public/docs/integration.md) - [Application Statuses](https://developer.alloy.com/public/docs/application-statuses.md) - [Rerunning Journey Applications](https://developer.alloy.com/public/docs/rerunning-journey-applications.md) - [Introduction to Ongoing Monitoring](https://developer.alloy.com/public/docs/introduction-to-ongoing-monitoring.md) - [Terminology](https://developer.alloy.com/public/docs/ongoing-terminology.md) - [Alloy Internal Services](https://developer.alloy.com/public/docs/alloy-internal-services.md) - [Decisioning with Events](https://developer.alloy.com/public/docs/decisioning-with-events.md) - [Event Status & Lifecycles](https://developer.alloy.com/public/docs/event-status-lifecycles.md) - [Request Overview](https://developer.alloy.com/public/docs/api-request.md) - [Event Types](https://developer.alloy.com/public/docs/event-types.md) - [Person Created](https://developer.alloy.com/public/docs/event-types-person-created.md): A person Entity along with their PII has been created. - [Person Updated](https://developer.alloy.com/public/docs/event-types-person-updated.md): A person entity has been updated - [Business Created](https://developer.alloy.com/public/docs/event-types-business-created.md): A business Entity along with their PII has been created - [Business Updated](https://developer.alloy.com/public/docs/event-types-business-updated.md): A business Entity has been updated - [Bank Account Created](https://developer.alloy.com/public/docs/event-types-bank-account-created.md): A new Bank Account has been opened. - [Bank Account Updated](https://developer.alloy.com/public/docs/event-types-bank-account-updated.md): An existing Bank Account has been updated. - [External Account Created](https://developer.alloy.com/public/docs/event-types-external-account-created.md): An new external or funding Account has been linked. - [External Account Updated](https://developer.alloy.com/public/docs/event-types-external-account-updated.md): An external or funding Account has been unlinked or re-linked. - [Transaction](https://developer.alloy.com/public/docs/event-types-transaction.md): A transaction for a specific Entity and Bank Account has been created or updated. - [Login](https://developer.alloy.com/public/docs/event-types-login.md): A login for a specific Entity has occurred. - [Credentials Updated](https://developer.alloy.com/public/docs/event-types-credentials-updated.md): The credentials for a specific Entity have been updated. - [Embedded Authentication](https://developer.alloy.com/public/docs/event-types-embedded-authentication.md): A new authentication to an embedded application (Zelle, Bill Pay) has occurred. - [Modify Notification](https://developer.alloy.com/public/docs/event-types-modify-notification.md): The notification settings for a specific Entity have been updated. - [Card Created](https://developer.alloy.com/public/docs/event-types-card-created.md): A new Card has been issued. - [Integrating with Events](https://developer.alloy.com/public/docs/integrating-with-events.md) - [Creating Entities and Accounts](https://developer.alloy.com/public/docs/creating-entities-and-bank-accounts-events.md) - [Card Accounts](https://developer.alloy.com/public/docs/creating-card-accounts-events.md) - [Monitoring Events](https://developer.alloy.com/public/docs/monitoring-events.md) - [Data Storing Events](https://developer.alloy.com/public/docs/data-storing-events.md) - [Transaction Event Mapping](https://developer.alloy.com/public/docs/monitoring-events-transactions.md) - [Identifying Devices](https://developer.alloy.com/public/docs/devices.md) - [Example Scenarios](https://developer.alloy.com/public/docs/example-ongoing-scenarios.md) - [Logins](https://developer.alloy.com/public/docs/example-scenario-logins.md) - [Verifying PII Updates](https://developer.alloy.com/public/docs/example-scenario-verifying-pii-updates.md) - [Linking Funding Accounts](https://developer.alloy.com/public/docs/example-scenario-linking-funding-accounts.md) - [Transaction After Suspicious PII Update](https://developer.alloy.com/public/docs/example-scenario-transaction-suspicious-pii-update.md) - [Webhooks](https://developer.alloy.com/public/docs/webhooks.md): Use webhooks to get real-time updates from Alloy - [Authentication Types](https://developer.alloy.com/public/docs/authentication-types.md) - [Basic Authentication](https://developer.alloy.com/public/docs/basic-authentication.md): Availability: All Customers - [Hash-based Message Authentication Code (HMAC)](https://developer.alloy.com/public/docs/hash-based-message-authentication-code-hmac.md): Availability: on request - [OAuth2.0](https://developer.alloy.com/public/docs/oauth20.md): Alloy support two grant types: Client Credentials, and Password. - [Client Credentials](https://developer.alloy.com/public/docs/client-credentials.md): Availability: All Customers - [Password](https://developer.alloy.com/public/docs/password.md): Availability: All Customers - [Webhook Source IPs](https://developer.alloy.com/public/docs/webhook-source-ip-addresses.md) - [Best Practices](https://developer.alloy.com/public/docs/best-practices.md) - [Retry Logic](https://developer.alloy.com/public/docs/retry-logic-and-webhook-logs.md) - [Webhook Logs](https://developer.alloy.com/public/docs/webhook-logs.md) - [Webhook Events](https://developer.alloy.com/public/docs/webhook-events.md): Alloy can trigger webhooks for a number of different events - [Journeys Events](https://developer.alloy.com/public/docs/journey-events.md) - [Investigations Events](https://developer.alloy.com/public/docs/investigations-events.md): Events related to Investigations that will trigger webhooks - [Case Management Events](https://developer.alloy.com/public/docs/cases.md) - [Web SDK](https://developer.alloy.com/public/docs/document-verification-web-sdk.md) - [Alloy SDK Installation](https://developer.alloy.com/public/docs/sdk-installation.md) - [Web SDK Functions](https://developer.alloy.com/public/docs/alloy-sdk-functions.md) - [Supported Plugins](https://developer.alloy.com/public/docs/supported-plugins.md) - [Alloy Dashboard Setup](https://developer.alloy.com/public/docs/alloy-dashboard-setup.md) - [Customization](https://developer.alloy.com/public/docs/customization.md) - [Socure Digital Intelligence Integration](https://developer.alloy.com/public/docs/device-risk.md) - [Experian FraudNet Integration](https://developer.alloy.com/public/docs/copy-of-socure-digital-intelligence-integration.md) - [TruValidate (Iovation) Device Risk Integration](https://developer.alloy.com/public/docs/truvalidate-device-risk-integration.md) - [ThreatMetrix Integration](https://developer.alloy.com/public/docs/threatmetrix-sdk-integration.md) - [NeuroID Integration](https://developer.alloy.com/public/docs/neuroid-integration.md): Alloy's SDK supports NeuroID's Behavioral Risk product - [Web SDK Theme Customization](https://developer.alloy.com/public/docs/web-sdk-theme-customizations.md) - [Alloy Hosted SDK](https://developer.alloy.com/public/docs/alloy-hosted-sdk.md) - [BioCatch Integration](https://developer.alloy.com/public/docs/biocatch-integration.md) - [iOS Webview](https://developer.alloy.com/public/docs/ios-webview.md) - [Android Webview](https://developer.alloy.com/public/docs/android-webview.md) - [Android Web SDK Installation](https://developer.alloy.com/public/docs/alloy-android-web-sdk-installation.md) - [Android Web SDK Classes & Functions](https://developer.alloy.com/public/docs/alloy-android-web-classes-functions.md) - [Custom Attributes (Published Attributes)](https://developer.alloy.com/public/docs/published-attributes.md) - [Define Published Attributes](https://developer.alloy.com/public/docs/define-published-attributes.md) - [Publishing New Values](https://developer.alloy.com/public/docs/publishing-new-values.md) - [Output Attribute Usage](https://developer.alloy.com/public/docs/output-attribute-usage.md) - [Introduction to Custom Models](https://developer.alloy.com/public/docs/introduction-to-custom-models.md) - [Customer Hosted Models](https://developer.alloy.com/public/docs/customer-hosted-models.md) - [Alloy Hosted Models](https://developer.alloy.com/public/docs/alloy-hosted-models.md) - [Developing & Testing Your Custom Model](https://developer.alloy.com/public/docs/developing-and-testing-your-custom-model.md) - [Custom Model Workflow Configuration](https://developer.alloy.com/public/docs/custom-model-workflow-configuration.md) - [Error Codes](https://developer.alloy.com/public/docs/_errors.md) - [Data Validation](https://developer.alloy.com/public/docs/data-validation.md) - [API Errors and Latency](https://developer.alloy.com/public/docs/monitoring-api-health-signals.md) - [Request Handling and Retries](https://developer.alloy.com/public/docs/request-handling-retry.md) - [Webhooks and Notifications](https://developer.alloy.com/public/docs/webhooks-and-notifications.md) - [Policy Design for Service Failures](https://developer.alloy.com/public/docs/policy-design-for-service-failures.md) - [Platform Health](https://developer.alloy.com/public/docs/status-alerting.md) ## API Reference - [Sandbox vs. Production](https://developer.alloy.com/public/reference/sandbox-vs-production.md) - [Create an account](https://developer.alloy.com/public/reference/post_accounts.md): This endpoint is deprecated in favor of the Events API using an event of type "bank_account_created". - [Update an account](https://developer.alloy.com/public/reference/patch_accounts-bank-account-token.md): This endpoint is deprecated in favor of the Events API using an event of type "bank_account_updated". - [Get a single bank account, with historical and entity data, by unique token or identifier.](https://developer.alloy.com/public/reference/get_bank-accounts-account-identifier-or-token.md): 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. - [Get Information Related to a Batch](https://developer.alloy.com/public/reference/get_batches-batch-token-2.md) - [Get a list of all possible cases created using Alloy Case Management.](https://developer.alloy.com/public/reference/get_cases-2.md): This endpoint is deprecated in favor of using Investigations. Retrieves the list of all cases, for the provided filter parameters - [Get a case by a uniquely defined case token](https://developer.alloy.com/public/reference/get_cases-case-token-2.md): This endpoint is deprecated in favor of using Investigations. Retrieves a single case uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". - [Get case evidences by case token](https://developer.alloy.com/public/reference/get_cases-case-token-evidences-2.md): This endpoint is deprecated in favor of using Investigations. Retrieves a list of case evidences uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix "C-". - [Create a case evidence](https://developer.alloy.com/public/reference/post_cases-case-token-evidences.md): Create a new manual tag and/or line item associated to an existing case - [Get case works for a case](https://developer.alloy.com/public/reference/get_cases-case-token-works-2.md): This endpoint is deprecated in favor of using Investigations. Retrieves a list of case works defined for a given case by a case token. Case work is any action an agent takes on a case. Some examples of types of work are `closure` (close a case), `status` (change case status), `assignment_created` (assigning an agent), or `note` (leave a note on a case). All type of case work can have a note. - [Create a case work (single)](https://developer.alloy.com/public/reference/post_cases-case-token-works.md): Enables an agent to take action on a single case at a time. There are nine types of actions that can be taken on an individual level: `assignment_created` (assigning a user to the cases), `assignment_removed` (unassigning a user to the cases), `status` (changing the statuses), `closure` (closing the cases), `note` (adding a note to a case), `read` (viewing a case after an update) `manual_evidence_added` (when a tag or line item is manually added to a case), `case_escalation_created` (a case was re-assigned and escalated), and finally `case_escalation_removed` (a case escalation was removed). - [Create a case work (multi)](https://developer.alloy.com/public/reference/post_cases-multi-works.md): This endpoint is deprecated in favor of using Investigations. Enables an agent to take action on multiple cases at once. There are four types of actions that can be taken on a bulk level: `assignment_created` (assigning a user to the cases), `assignment_removed` (unassigning a user to the cases), `status` (changing the statuses), and `closure` (closing the cases). - [Show dataset related to a case-generating tag](https://developer.alloy.com/public/reference/get_cases-case-token-evidences-evaluation-token-alert.md): This endpoint is deprecated in favor of using Investigations. When activity results in case creation through an evaluation, this will return activity data that meets the tag criteria. This can include transaction data, PII updates, account data, sanctions screening data, or even more. - [Create a New Custom List](https://developer.alloy.com/public/reference/post_custom-lists.md): Create a new custom list with input metadata - [Get all Custom Lists](https://developer.alloy.com/public/reference/get_custom-lists.md): Returns the set of all Custom Lists created per customer - [Update Custom List Metadata](https://developer.alloy.com/public/reference/patch_custom-lists-customlisttoken.md): Update the name or description of a custom list - [Get Custom List Versions](https://developer.alloy.com/public/reference/get_custom-lists-customlisttoken.md): Return all versions of the specified custom list - [Create a new Custom List Version](https://developer.alloy.com/public/reference/post_custom-lists-customlisttoken-versions.md):
To create a new major version of a list:
- Define or update columns and provide entries.
To create a new minor version of a list:
- Add entries to an existing version.
- Delete entries from an existing version.
- Modify entries in an existing version.
- Replace all entries in an existing version.
- Restore an existing version.
- [Get a Specific Custom List Version](https://developer.alloy.com/public/reference/get_custom-lists-customlisttoken-versions-version.md): Return the data and metadata for a specific version of a custom list - [Activate a Custom List Version](https://developer.alloy.com/public/reference/post_custom-lists-customlisttoken-activate-major-version.md): Activate a specific major version of a custom list. The actual list version used in a realtime evaluation will be the latest minor version for the major version. - [Describe a Document Before an Entity is Created](https://developer.alloy.com/public/reference/post_documents-2.md) - [Submit a Document File Before an Entity is Created](https://developer.alloy.com/public/reference/put_documents-document-token-2.md): Now that the metadata for the file has been specified, you just need to stream the file to the location we’ve allocated for it. The response should be the same as for the preceding `POST` request endpoint except `uploaded` will be true. - [Describe a Document Before Uploading](https://developer.alloy.com/public/reference/post_entities-entity-token-documents-2.md): The document upload API is a two-step process. First, the metadata for the document is specified, and the API returns a file identifier so the file can be streamed directly to the next endpoint. You’ll need to look for the document_token returned in the response because that is necessary to pass to the next endpoint for streaming the file. - [Get a List of All Documents for an Entity](https://developer.alloy.com/public/reference/get_entities-entity-token-documents-2.md): All documents for an entity can be queried using this endpoint. All metadata for the documents is available, but the documents themselves must be downloaded individually. - [Submit a Document File for an Entity](https://developer.alloy.com/public/reference/put_entities-entity-token-documents-document-token-2.md): Now that the metadata for the file has been specified, you just need to stream the file to the location we’ve allocated for it. The response should be the same as for the preceding `POST` request endpoint except `uploaded` will be true. - [Update Document Metadata](https://developer.alloy.com/public/reference/patch_entities-entity-token-documents-document-token-2.md): If you want to mark a document as “approved” or “denied” (if you have a document review process), or just change the name or type of a document, you can do so with the PATCH endpoint. - [Download a Document](https://developer.alloy.com/public/reference/get_entities-entity-token-documents-document-token-2.md): This endpoint will return a file stream of the requested document. - [Add Notes to a Document](https://developer.alloy.com/public/reference/post_entities-entity-token-documents-document-token-notes-2.md): You can add an unlimited amount of notes to a document to keep track of whatever information is needed. All you need is to pass the note along with the email of the author of the note (must be a user associated with your customer account) to this API endpoint. - [Get Information Related to an Entity](https://developer.alloy.com/public/reference/get_entities-entity-token-2.md) - [Get An Evaluation](https://developer.alloy.com/public/reference/get_entities-entity-token-evaluations-evaluation-token-2.md): 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. - [Add a Note for an Entity](https://developer.alloy.com/public/reference/post_entities-entity-token-notes-2.md): Adds a note to an existing entity. - [Create a person entity](https://developer.alloy.com/public/reference/post_entities-persons.md): Creates a person entity - [Get a person entity](https://developer.alloy.com/public/reference/get_entities-persons-entity-token.md): Retrieves information associated with specified person entity token This endpoint supports the Alloy Entity token or your `external_entity_id`. - [Update a person entity](https://developer.alloy.com/public/reference/patch_entities-persons-entity-token.md): Using a person entity token, update entity with provided information - [Create a business entity](https://developer.alloy.com/public/reference/post_entities-businesses.md): Creates a business entity - [Get a business entity](https://developer.alloy.com/public/reference/get_entities-businesses-entity-token.md): Retrieves information associated with specified business entity token - [Update a business entity](https://developer.alloy.com/public/reference/patch_entities-businesses-entity-token.md): Using a business entity token, update entity with provided information - [Merge two entities](https://developer.alloy.com/public/reference/post_entities-merge.md): Merge the properties of the secondary entity into the primary entity. Required - one of (primary_entity_token / primary_external_entity_id) and one of (secondary_entity_token and secondary_external_entity_id). - [Runs an evaluation](https://developer.alloy.com/public/reference/post_evaluations.md): Given a workflow specified by the header, the API will run an evaluation with the provided payload. Alloy's API is dynamic, and thus the input parameters vary depending on which services are run and how the workflow is configured. - [Returns a list of required and optional inputs](https://developer.alloy.com/public/reference/get_parameters.md): Given a workflow specified by the header, the API returns a list of required and optional inputs for running an evaluation through the designated workflow. Alloy's API is dynamic, and thus the input parameters vary depending on which services are run and how the workflow is configured. Hitting the `GET /parameters` endpoint will show exactly what your initial `POST /evaluations` request to the Alloy API should look like. All attributes will either be always required, conditionally required, or optional. For instance, in the example here, you either have to pass `document_ssn` OR both `document_license` and `document_license_state`. Note that this response body is just an example, and the exact parameters of your workflow version will vary. - [View Evaluation](https://developer.alloy.com/public/reference/get_evaluations-evaluation-token.md) - [Updates an evaluation](https://developer.alloy.com/public/reference/patch_evaluations-evaluation-token.md): Updates an existing unresolved evaluation (waiting on required inputs), data supplied in the request body will be merged with data supplied from the initial `POST` request. Note that `null` values supplied for fields in the request body are treated as "do not change" and no updates will happen with those fields. - [Update Partial Audit Access for Evaluation](https://developer.alloy.com/public/reference/patch_evaluations-evaluation-token-auditaccess.md): Updates the partial audit access permissions for an evaluation. This endpoint allows child customers in an Embedded Finance setup to grant partial audit access to parent organizations. Partial audit access enables parent organizations to view specific evaluations without having full access to all data in the child account. This is useful for compliance, monitoring, and oversight purposes while maintaining appropriate data boundaries between organizations. **Important Notes:** - This endpoint can only be called by child customers in an Embedded Finance relationship. - Only parent organizations with `partial_audit` access type can be granted access via this endpoint. - The request must include the `alloy-audit-account-slugs` header with comma-separated organization slugs. - Access is managed at the evaluation, entity, and related resource (e.g., bank accounts) level. - Previously granted access can be revoked by omitting the organization slug from subsequent requests. - [Create an event](https://developer.alloy.com/public/reference/post_events.md) - [Get the schema for request event type](https://developer.alloy.com/public/reference/get_events-schema.md): Retrieves the schema for requested event type - [Get an event by token](https://developer.alloy.com/public/reference/get_events-event-request-token.md): Retrieves a previously submitted event by its event request token, including the original request body. - [Get information about an Entity Group](https://developer.alloy.com/public/reference/get_entity-groups-entity-token-or-external-id.md): Using an Entity Group's token or external identifier, get information about the Entity Group and its relationships - [Append entity feedback](https://developer.alloy.com/public/reference/post_entity-feedback.md): Insert a list of entity feedback while leaving the rest of the existing entity feedback intact - [Get entity feedback](https://developer.alloy.com/public/reference/get_entity-feedback.md): Get a list of entity feedback - [Get Information Related to a Group](https://developer.alloy.com/public/reference/get_groups-entity-token.md): This endpoint is deprecated in favor of using [Entity Groups](/reference/get_entity-groups-entity-token-or-external-id). - [Post a Group Evaluation](https://developer.alloy.com/public/reference/post_groups-grouptoken-evaluations.md): This endpoint is deprecated in favor of using Entity Groups in Journeys. Given a workflow with a Group Service, this endpoint can evaluate a group of entities. - [Add note to a group](https://developer.alloy.com/public/reference/post_groups-grouptoken-notes.md): This endpoint is deprecated in favor of using Entity Groups in Journeys. - [Investigations](https://developer.alloy.com/public/reference/investigations.md) - [Get list of Investigations](https://developer.alloy.com/public/reference/get_investigations.md): Retrieves a filterable paginated list of investigations - [Create an Investigation](https://developer.alloy.com/public/reference/post_investigations.md): Manually creates a new Investigation - [Get an Investigation](https://developer.alloy.com/public/reference/get_investigations-investigation-token.md): Returns the details of an individual Investigation. - [Get Investigation filters](https://developer.alloy.com/public/reference/get_investigations-filters.md): Returns all the currently used filters in all investigations - [Get list of assignable agents](https://developer.alloy.com/public/reference/get_investigations-assignable-agents.md): Returns all available agents - [Update Investigation Evidences](https://developer.alloy.com/public/reference/patch_investigations-investigation-token-evidences.md): Updates the Investigation with Evidences. - [Append a review to an Investigation Alert](https://developer.alloy.com/public/reference/put_investigations-investigation-token-alerts-journey-application-token-review.md): Appends a review to an Investigation Alert - [Get an Investigation Alert](https://developer.alloy.com/public/reference/get_investigations-investigation-token-alerts-journey-application-token.md): Returns an alert associated with an investigation - [Review an Investigation Alert](https://developer.alloy.com/public/reference/post_investigations-investigation-token-alerts-journey-application-token-review-manual-review-token-review.md): Reviews an alert attached to an investigation - [Assign an Investigation Alert to an Agent](https://developer.alloy.com/public/reference/put_investigations-investigation-token-alerts-journey-application-token-assign.md): Assigns an Investigation Alert to an Agent - [Unassign an Alert from an Investigation](https://developer.alloy.com/public/reference/put_investigations-investigation-token-alerts-journey-application-token-unassign.md): Unassign Agents from an Investigation Alert - [Promote Investigation Alert to Case Review](https://developer.alloy.com/public/reference/put_investigations-investigation-token-promote.md): Promotes an Investigation from Alert Review to Case Review. - [Assign Investigations](https://developer.alloy.com/public/reference/put_investigations-assign.md): Assigns one or more Investigations to an Agent - [Unassign Investigations](https://developer.alloy.com/public/reference/put_investigations-unassign.md): Unassign one or more Investigations - [Archive Investigations](https://developer.alloy.com/public/reference/put_investigations-archive.md): Archives one or more Investigations - [Unarchive Investigations](https://developer.alloy.com/public/reference/put_investigations-unarchive.md): Unarchives one or more Investigations - [Add note to Investigation](https://developer.alloy.com/public/reference/post_investigations-investigation-token-notes.md): Add a note to an investigation - [Review and close an investigation](https://developer.alloy.com/public/reference/put_investigations-investigation-token-review.md): Reviews an investigation and closes it. - [Get list of Investigation types](https://developer.alloy.com/public/reference/get_investigations-types.md): Retrieves a filterable paginated list of investigation types - [Create Investigation type](https://developer.alloy.com/public/reference/post_investigations-types.md): Creates an Investigation type - [Get list of Investigation type use cases](https://developer.alloy.com/public/reference/get_investigations-use-cases.md): Retrieves a list of investigation type use cases - [Archive Investigation type](https://developer.alloy.com/public/reference/patch_investigations-types-archive.md): Archives an Investigation type - [Unarchive Investigation type](https://developer.alloy.com/public/reference/patch_investigations-types-unarchive.md): Unarchives an Investigation type - [Delete Investigation type](https://developer.alloy.com/public/reference/patch_investigations-types-delete-investigation-type.md): Deletes an Investigation type - [Create Journey Application](https://developer.alloy.com/public/reference/post_journeys-journey-token-applications.md): Create a journey application for one or more entities. - [Get latest Journey Application by External Application ID](https://developer.alloy.com/public/reference/get_journeys-applications-ext-external-application-id-latest.md): This endpoint retrieves the latest (i.e. most recently created) Application associated with the supplied External Application ID. If the `journeyToken` query parameter is provided, the retrieved Application will be the latest Application associated with that particular Journey and the External Application ID. - [Update latest Journey Application by External Application ID](https://developer.alloy.com/public/reference/put_journeys-applications-ext-external-application-id-latest.md): This endpoint allows you to update the latest (i.e. most recently created) Application associated with the supplied External Application ID. If the `journeyToken` query parameter is provided, the retrieved Application will be the latest Application associated with that particular Journey and the External Application ID. The use cases for the endpoint are elaborated in the regular "Update Journey Application" endpoint. - [Get Journey Applications by Alloy Entity Token or External Entity ID.](https://developer.alloy.com/public/reference/get_journeys-entities-external-entity-id-applications.md): This endpoint retrieves a list of Journey Applications associated with the supplied Alloy Entity Token or an External Entity ID. - [Rerun Journey Application](https://developer.alloy.com/public/reference/post_journeys-journey-token-applications-journey-application-token-rerun.md): This endpoint re-runs an application that has already been run through Alloy. It will be run through the currently active version of the Journey, and will default to re-using the same payload as the original, but does allow for the user to optionally alter that original payload. The options for altering are the following: - Edit any of the payload information for any of the entities in the application by including, within an object in the `entities` array, the `entity_token` of the entity to be altered. Include any number of fields to be altered. Assign a value of null for any field you want to exclude. - Add any number of new entities to the application by including new entity objects in the payload. - Delete entire entities by putting these entity tokens to be deleted into an array called `exclude_entity_tokens` (at least one entity must remain). Any of the below headers used with the original application will also be used here. To change the value of the header, include the updated value with this request. - [Rerun latest Journey Application by External Application ID](https://developer.alloy.com/public/reference/post_journeys-applications-ext-external-application-id-latest-rerun.md): This endpoint reruns the latest (i.e. most recently created) Application associated with the supplied External Application ID. If the `journeyToken` query parameter is provided, the retrieved Application will be the latest Application associated with that particular Journey and the External Application ID. Just as with our other rerun endpoint, this will create a new Journey Application. - [Update Journey Application](https://developer.alloy.com/public/reference/put_journeys-journey-token-applications-journey-application-token.md): This endpoint has 3 different use cases: * Send the additional or updated data required to advance the application. * Only available if one or more entity applications have the statuses `pending_documents`, `pending_step_up`, or `data_request`. * Send new, additional entities to be processed. * Only available if the parameter `do_await_additional_entities` was set to `true` in the POST request to create the journey application. * Inform the system that the user has finished sending all additional entities by passing the parameter `has_finished_sending_additional_entities` with value `true`. * Only available if the parameter `do_await_additional_entities` was set to `true` in the POST request to create the journey application. Any of the headers used with the original application (ex: `alloy-sandbox`) will also be used here. - [Get Journey Application](https://developer.alloy.com/public/reference/get_journeys-journey-token-applications-journey-application-token.md): Returns relevant data associated with a journey application. - [Update Journey Application Action Node](https://developer.alloy.com/public/reference/put_journeys-journey-token-applications-journey-application-token-nodes-node-id.md): If an entity application has the status `pending_action`, this endpoint must be used to inform the system of the outcome of the action and advance the application accordingly. For multi-entity applications, the entity application must be identified by sending either `entity_application_token`, `entity_token`, or `external_entity_id`. See those parameters' descriptions for more detail. If the action has been configured to expire, the system checks if an action has expired every 12 hours from the time the application visits the action node. The system also checks for expiration if a request to this endpoint is made, and the application will advance according to the journey configuration if the action node has expired. Additional data can also be optionally sent to the subsequent nodes in order to update the application. - [Manual Review Entity Application](https://developer.alloy.com/public/reference/post_journeys-journey-token-applications-journey-application-token-cases-case-token-review.md): If an entity application has the status `waiting_review`, this endpoint can be used to inform the system of the outcome of the manual review and submit review notes. In the first request for a given case, the outcome and optionally reason and note are submitted. In subsequent requests for the same case, only the note is allowed, as the review is closed and no longer accepting new outcomes or reasons. - [Manual Review Journey Application](https://developer.alloy.com/public/reference/post_journeys-journey-token-applications-journey-application-token-review.md): If a journey application has the status `pending_journey_application_review`, this endpoint can be used to inform the system of the outcome of the manual review and submit review notes. The outcome submitted here will be the final outcome of the journey application. - [Get Alert Manual Review Token](https://developer.alloy.com/public/reference/get_journeys-journey-token-applications-journey-application-token-review-manual-review-token.md): Retrieve an alert manual review by token - [Get Journey Schema](https://developer.alloy.com/public/reference/get_journeys-journey-token-schema.md): This endpoint retrieves the required and optional parameters for a given Journey. The parameters will be aggregated and segmented by branch. - [Get Journey Parameters](https://developer.alloy.com/public/reference/get_journeys-journey-token-parameters.md): This endpoint retrieves the required and optional parameters for all workflow nodes in the given Journey. The parameters will be aggregated and segmented by branch and then by workflow. Any workflow that exists more than once within a branch will be deduplicated in the response for that branch. - [Create Journey Application Batch](https://developer.alloy.com/public/reference/post_journeys-journey-token-batches.md): Create a batch of journey applications by passing in a list of entities, grouped into different applications by the multi_entity_application_batch_key that can be optionally supplied for each entity - [Get Journey Application Batch Summary](https://developer.alloy.com/public/reference/get_journeys-journey-token-batches-journey-batch-token.md): Get details about a specific journey application batch. - [Get Batch Journey Applications](https://developer.alloy.com/public/reference/get_journeys-journey-token-batches-journey-batch-token-applications.md): Get list of journey applications for specified batch. - [Create Journey Application Note](https://developer.alloy.com/public/reference/post_journeys-journey-token-applications-journey-application-token-notes.md): Create a note associated with the specified Journey Application - [Get Journey Application Notes](https://developer.alloy.com/public/reference/get_journeys-journey-token-applications-journey-application-token-notes.md): Retrieve all notes associated with the specified Journey Application - [Update Partial Audit Access for Journey Application](https://developer.alloy.com/public/reference/patch_journeys-journey-token-applications-journey-application-token-auditaccess.md): Updates the partial audit access permissions for a journey application and all associated evaluations, entities, and resources. This endpoint allows child customers in an Embedded Finance setup to grant partial audit access to parent organizations. Partial audit access enables parent organizations to view specific journey applications and their related data without having full access to all data in the child account. This is useful for compliance, monitoring, and oversight purposes while maintaining appropriate data boundaries between organizations. **Important Notes:** - This endpoint can only be called by child customers in an Embedded Finance relationship. - Only parent organizations with `partial_audit` access type can be granted access via this endpoint. - The request must include the `alloy-audit-account-slugs` header with comma-separated organization slugs. - Access is managed at multiple levels including: - Journey Application - All evaluations within the application - All entities associated with the evaluations - Related resources (e.g., bank accounts for transaction evaluations) - Previously granted access can be revoked by omitting the organization slug from subsequent requests. - [Get all Lists](https://developer.alloy.com/public/reference/get_lists.md): Returns the set of all Lists for your account - [Create a new list](https://developer.alloy.com/public/reference/post_lists.md): Create a new list with input metadata - [Update list metadata](https://developer.alloy.com/public/reference/put_lists-list-token-meta.md): Update list name or description - [Get one List's entities](https://developer.alloy.com/public/reference/get_lists-list-token.md): Return all entities belonging to the specified List - [Add an entity to a List](https://developer.alloy.com/public/reference/post_lists-list-token.md): Add an individual to a List while leaving the rest of the List's records intact - [Replace the entire List](https://developer.alloy.com/public/reference/put_lists-list-token.md): Overwrite the entire List with the contents of the submitted array - [Generate a new OAuth bearer token from the given client credentials.](https://developer.alloy.com/public/reference/post_oauth-bearer-2.md): Application token and application secret MUST be provided, either as properties in the JSON body, or in the Authorization header. The returned bearer token will allow the client all the same access permissions as the given application token and secret. Bearer tokens are sent in the `Authorization` header in the form `Bearer `. All bearer tokens expire one hour from generation. - [Validate a bearer token.](https://developer.alloy.com/public/reference/post_oauth-validate-2.md): Check if a given bearer token is valid and unexpired. **Note that** the bearer token MUST be sent in the JSON body; it CANNOT be sent as an Authorization header. - [Runs a portfolio evaluation](https://developer.alloy.com/public/reference/post_portfolio-evaluations.md): Given a portfolio workflow specified by the header, the API will run a portfolio evaluation. - [Rerun a portfolio evaluation](https://developer.alloy.com/public/reference/post_portfolio-evaluations-portfolio-evaluation-token-rerun.md): Reruns a portfolio evaluation that has already been run. A new portfolio evaluation token is generated for the rerun. The workflow version and the run-as-of time are the same as the original. - [List Published Attributes](https://developer.alloy.com/public/reference/get_published-attributes.md) - [Create Published Attribute](https://developer.alloy.com/public/reference/post_published-attributes.md) - [Get Published Attribute](https://developer.alloy.com/public/reference/get_published-attributes-published-attribute-token.md) - [Update Published Attribute](https://developer.alloy.com/public/reference/patch_published-attributes-published-attribute-token.md) - [Get Published Attribute Values for an Entity](https://developer.alloy.com/public/reference/get_published-attributes-published-attribute-token-values.md) - [Create Published Attribute Values](https://developer.alloy.com/public/reference/post_published-attributes-published-attribute-token-values.md) - [Retrieve a Review](https://developer.alloy.com/public/reference/get_entities-entity-token-reviews-review-token-2.md): This endpoint is deprecated in favor of Journeys. - [Add a Note to a Review.](https://developer.alloy.com/public/reference/post_entities-entity-token-reviews-review-token-notes-2.md): This endpoint is deprecated in favor of Journeys. - [Retrieve All Reviews for an Entity](https://developer.alloy.com/public/reference/get_entities-entity-token-reviews-2.md): This endpoint is deprecated in favor of Journeys. - [Create a Review for an Entity](https://developer.alloy.com/public/reference/post_entities-entity-token-reviews-2.md): This endpoint is deprecated in favor of Journeys. When an evaluation is assigned a “Manual Review” outcome, it goes to the Review Queue. While evaluations can be managed in the dashboard, it is also possible to change a status via API. This endpoint can only be used for non-Journey evaluations. To review Journey or Entity applications, see the Journeys section. **A few things to note:** * The agent whose email you include in the body of the request must be an agent on the account (View agents on the account via the main page of your account under "Agents"). * The chosen outcome for the evaluation, as well as the reason given for that outcome in the body of the API request, must perfectly match those set up in Settings --> Review Reasons. - [Create a Review for a Group.](https://developer.alloy.com/public/reference/post_groups-group-token-reviews-2.md): This endpoint is deprecated in favor of Journeys. - [Add a Note to a Review Group.](https://developer.alloy.com/public/reference/post_groups-group-token-reviews-review-token-notes.md): This endpoint is deprecated in favor of Journeys. - [Get a transaction.](https://developer.alloy.com/public/reference/get_transactions-transaction-id.md): Retrieves a Transaction by external transaction ID. *Note*: If you are using the Alloy Events API, you do not need to use any of the Transactions endpoints. All data should be sent through the Events API with a relevant `event_type`. - [Update a transaction.](https://developer.alloy.com/public/reference/patch_transactions-transaction-id.md): Updates a Transaction by external transaction ID. *Note*: If you are using the Alloy Events API, you do not need to use any of the Transactions endpoints. All data should be sent through the Events API with a relevant `event_type`. ## Recipes - [Doc Verification SDK Initialization Parameters](https://developer.alloy.com/public/recipes/doc-verification-sdk-initialization-parameters.md) - [Run Sandbox Application through Journey](https://developer.alloy.com/public/recipes/run-sandbox-application-through-journey.md) - [Trigger Alloy's Doc Verification SDK](https://developer.alloy.com/public/recipes/trigger-alloys-doc-verification-sdk.md)