Skip to main content

Persona

Persona is an identity verification platform for KYC, document verification, and fraud prevention. The Persona API provides programmatic access to accounts, inquiries, cases, and connections so you can manage verified identity data and automate compliance workflows. Nexla connects to the Persona REST API to ingest identity and account data as a source or to send updates and actions to Persona as a destination.

Persona icon

Power end-to-end data operations for your Persona API with Nexla. Our bi-directional Persona connector is purpose-built for Persona, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Persona or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Persona workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Persona credential, you need to obtain an API key from your Persona account. Persona uses HTTP Bearer authentication, and the API key is sent in the Authorization header as Bearer <API_KEY> on every request over HTTPS.

To obtain your Persona API key, follow these steps:

  1. Sign in to your Persona Dashboard at app.withpersona.com.

  2. Navigate to API > API Keys to view the API keys for your organization.

  3. Each environment (for example, sandbox and production) has its own API key. Select or create the key for the environment you intend to use with Nexla.

  4. Click Create API key, enter a name for the key, and click Create to generate a new key.

  5. Optionally, configure the key's permissions under API > API Keys > Edit > Permissions to limit read or write access to specific API resources.

  6. Copy the generated API key and store it securely. Your API key carries many privileges, so keep it confidential and do not expose it in publicly accessible areas such as source control or client-side code.

For detailed information about authentication, API keys, and available endpoints, see the Persona API Documentation.

Authenticate

Credentials required

An authentication method that requires sending a unique secret token with each API request

FieldRequiredSecretDescription
API Key ValueYesYesAn encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Persona API key in the API Key Value field. This value is sent as a Bearer token in the Authorization header to authenticate all requests to the Persona API and must be kept confidential.

    If your API key is compromised, revoke it in the Persona Dashboard under API > API Keys and generate a new one. API keys carry many privileges and should be treated as sensitive information.

    For detailed information about authentication, API keys, and available endpoints, see the Persona API Documentation.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Persona connector tile, then select the credential that will be used to connect to Persona, and click Next; or, create a new Persona credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Persona endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List all Accounts

This endpoint template retrieves a list of all accounts in your Persona organization. Use this template when you need to ingest account records for analysis, reporting, or synchronization with other systems.

For detailed information about accounts, response structures, and pagination, see the Persona API Documentation.

[Rest API] Retrieve an Account

This endpoint template retrieves a single account from your Persona organization by its account identifier. Use this template when you need detailed information about a specific account.

For detailed information about account fields and response structures, see the Persona API Documentation.

[Rest API] Retrieve an Account Type

This endpoint template retrieves an account type definition from your Persona organization. Use this template when you need to inspect the configuration and attributes associated with a Persona account type.

For detailed information about account types, see the Persona API Documentation.

[Rest API] Create an Account

This endpoint template creates a new account in your Persona organization. Use this template when you need to programmatically add account records based on data from your Nexla flows.

For detailed information about the request body and required fields for account creation, see the Persona API Documentation.

[Rest API] Update an Account

This endpoint template updates an existing account in your Persona organization. Use this template when you need to modify account attributes based on data from your Nexla flows.

For detailed information about updatable account fields, see the Persona API Documentation.

[Rest API] Get all relations for an Account

This endpoint template retrieves all relations associated with a specific account. Use this template when you need to ingest the relationships linked to a Persona account.

For detailed information about account relations, see the Persona API Documentation.

[Rest API] Add a relation to an Account

This endpoint template adds a relation to a specific account in your Persona organization. Use this template when you need to link related records to a Persona account.

For detailed information about adding account relations, see the Persona API Documentation.

[Rest API] Remove a relation from an Account

This endpoint template removes a relation from a specific account in your Persona organization. Use this template when you need to unlink related records from a Persona account.

For detailed information about removing account relations, see the Persona API Documentation.

[Rest API] Add tag to an Account

This endpoint template adds a tag to a specific account in your Persona organization. Use this template when you need to label or categorize accounts based on data from your Nexla flows.

For detailed information about account tags, see the Persona API Documentation.

[Rest API] Remove tag from an Account

This endpoint template removes a tag from a specific account in your Persona organization. Use this template when you need to remove a label or category from an account.

For detailed information about account tags, see the Persona API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Persona data sources can also be manually configured to ingest data from any valid Persona API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Persona data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Persona destination, and select the Send to Destination option from the menu. Select the Persona connector from the list of available destination connectors, then select the credential that will be used to connect to Persona, and click Next; or, create a new Persona credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Persona endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Import Accounts

This endpoint template imports account records into your Persona organization using data from a Nexset. Use this template when you need to bulk-load or migrate account data into Persona.

For detailed information about importing accounts and the expected request body, see the Persona API Documentation.

[Rest API] Consolidate Accounts

This endpoint template consolidates one or more accounts into a single account in your Persona organization. Use this template when you need to merge duplicate account records.

For detailed information about consolidating accounts, see the Persona API Documentation.

[Rest API] Run an account action

This endpoint template runs a configured action against an account in your Persona organization. Use this template when you need to trigger account-level workflows or automations from your Nexla flows.

For detailed information about account actions, see the Persona API Documentation.

[Rest API] Redact an Account

This endpoint template redacts an account in your Persona organization, permanently removing its personally identifiable information. Use this template to support data-retention and privacy compliance requirements.

Redaction permanently removes personally identifiable information and cannot be undone. For detailed information about redacting accounts, see the Persona API Documentation.

[Rest API] Redact an Inquiry

This endpoint template redacts an inquiry in your Persona organization, permanently removing its personally identifiable information. Use this template to support data-retention and privacy compliance requirements.

Redaction permanently removes personally identifiable information and cannot be undone. For detailed information about redacting inquiries, see the Persona API Documentation.

[Rest API] Redact a Case

This endpoint template redacts a case in your Persona organization, permanently removing its personally identifiable information. Use this template to support data-retention and privacy compliance requirements.

Redaction permanently removes personally identifiable information and cannot be undone. For detailed information about redacting cases, see the Persona API Documentation.

[Rest API] Create a Connection

This endpoint template creates a new Connect connection in your Persona organization. Use this template when you need to programmatically establish a connection based on data from your Nexla flows.

For detailed information about connections, see the Persona API Documentation.

[Rest API] Deactivate a Connection

This endpoint template deactivates an existing Connect connection in your Persona organization. Use this template when you need to disable a connection based on data from your Nexla flows.

For detailed information about connections, see the Persona API Documentation.

[Rest API] Reactivate a Connection

This endpoint template reactivates a previously deactivated Connect connection in your Persona organization. Use this template when you need to re-enable a connection based on data from your Nexla flows.

For detailed information about connections, see the Persona API Documentation.

[Rest API] Redeem a Share Token

This endpoint template redeems a share token in your Persona organization to access shared verification data. Use this template when you need to exchange a share token for the associated account or inquiry data.

For detailed information about share tokens, see the Persona API Documentation.

Manual configuration

Persona destinations can also be manually configured to send data to any valid Persona API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Persona APIs typically expect JSON format for most operations. For update operations, include the ID of the object to be updated at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Persona endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Persona endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.