Persona

Persona (withpersona.com) is a configurable identity platform for KYC, KYB, AML, and fraud prevention. Its JSON:API-style REST API lets organizations run identity Inquiries, collect Verifications (government ID, selfie, database, document, phone, and email), pull watchlist and adverse-media Reports, manage review Cases, score Transactions, and orchestrate Workflows, all under api.withpersona.com/api/v1.

13 APIs 0 Features

IdentityIdentity VerificationKYCKYBAMLFraudCompliance

APIs

Persona Inquiries API

An Inquiry represents a single instance of an individual attempting to verify their identity against a template. Create, retrieve, list, search, update, approve, decline, mark-f...

Persona Inquiry Sessions API

Inquiry Sessions represent an individual session within an Inquiry, letting you create, list, retrieve, expire, and generate one-time links so a person can resume a verification...

Persona Accounts API

An Account is the persistent record of an end user across Inquiries. Create, retrieve, list, search, update, consolidate, redact, tag, and manage relations between Accounts, and...

Persona Verifications API

A Verification answers whether an individual is who they claim to be across many types - government ID, government ID NFC, selfie, document, phone number, email address, and dat...

Persona Reports API

Reports run watchlist, adverse-media, PEP, and business lookups against an individual or entity. Create, retrieve, list, redact, tag, dismiss matches, pause/resume continuous mo...

Persona Cases API

Cases group Persona objects (Inquiries, Accounts, Reports) for manual review. Create, retrieve, list, search, update, assign, set status, add or remove objects, tag, and redact ...

Persona Transactions API

Transactions represent risk-scored events tied to an Account for ongoing fraud monitoring. Create, retrieve, list, update, tag, label, manage relations, redact, and redact trans...

Persona Devices API

Devices capture device-intelligence signals observed during a flow. List and retrieve Device records collected across Inquiries and Transactions.

Persona Documents API

Documents are files collected during verification. Retrieve a Document, a government-ID document, or a generic uploaded document by ID.

Persona Webhooks API

Manage webhook subscriptions that deliver Persona events to your endpoints. Create, retrieve, list, update, enable, disable, archive, clone, and rotate the signing secret of a W...

Persona Events API

Events are the immutable, queryable record of everything that happens in your Persona account. List and retrieve Events for audit and reconciliation with webhook payloads.

Persona Importers API

Importers bulk-load data into Persona lists. List and retrieve Importers and import accounts, names, emails, phone numbers, government ID numbers, IP addresses, geolocations, an...

Persona Workflows API

Workflows automate business logic by triggering actions based on verification results or other events. Create a Workflow Run, retrieve a run, and list all Workflow Runs.

Collections

Persona API

OPEN

Pricing Plans

Withpersona Plans Pricing

4 plans

PLANS

Rate Limits

Withpersona Rate Limits

3 limits

RATE LIMITS

FinOps

Withpersona Finops

FINOPS

Resources

🔗

VulnerabilityDisclosure

VulnerabilityDisclosure

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Persona API
  version: '2023-01-05'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
  header:
  - key: Persona-Version
    value: '{{personaVersion}}'
  - key: Key-Inflection
    value: camel
  - key: Content-Type
    value: application/json
items:
- info:
    name: Inquiries
    type: folder
  items:
  - info:
      name: List all Inquiries
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/inquiries
    docs: Returns a paginated list of your organization's Inquiries.
  - info:
      name: Create an Inquiry
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/inquiries
      body:
        type: json
        data: "{\n  \"data\": {\n    \"attributes\": {\n      \"inquiry-template-id\": \"itmpl_ABC123\"\n    }\n  }\n}"
    docs: Creates a new Inquiry against a template.
  - info:
      name: Retrieve an Inquiry
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/inquiries/:inquiry-id
    docs: Retrieves the details of an existing Inquiry.
  - info:
      name: Approve an Inquiry
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/inquiries/:inquiry-id/approve
    docs: Approves an Inquiry.
  - info:
      name: Decline an Inquiry
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/inquiries/:inquiry-id/decline
    docs: Declines an Inquiry.
- info:
    name: Inquiry Sessions
    type: folder
  items:
  - info:
      name: List all Inquiry Sessions
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/inquiry-sessions
    docs: Lists Inquiry Sessions.
  - info:
      name: Create an Inquiry Session
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/inquiry-sessions
      body:
        type: json
        data: '{}'
    docs: Creates an Inquiry Session.
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: List all Accounts
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/accounts
    docs: Retrieves a list of your organization's Accounts.
  - info:
      name: Create an Account
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/accounts
      body:
        type: json
        data: '{}'
    docs: Creates an Account.
  - info:
      name: Retrieve an Account
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/accounts/:account-id
    docs: Retrieves an Account.
- info:
    name: Verifications
    type: folder
  items:
  - info:
      name: Retrieve a Verification
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/verifications/:verification-id
    docs: Retrieves a Verification of any type (government ID, selfie, database, document, phone, email).
- info:
    name: Reports
    type: folder
  items:
  - info:
      name: List all Reports
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/reports
    docs: Lists Reports.
  - info:
      name: Create a Report
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/reports
      body:
        type: json
        data: '{}'
    docs: Runs a watchlist, adverse-media, PEP, or business Report.
- info:
    name: Cases
    type: folder
  items:
  - info:
      name: List all Cases
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/cases
    docs: Lists Cases.
  - info:
      name: Create a Case
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/cases
      body:
        type: json
        data: '{}'
    docs: Creates a Case.
- info:
    name: Transactions
    type: folder
  items:
  - info:
      name: List all Transactions
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/transactions
    docs: Lists Transactions.
  - info:
      name: Create a Transaction
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/transactions
      body:
        type: json
        data: '{}'
    docs: Creates a Transaction.
- info:
    name: Devices
    type: folder
  items:
  - info:
      name: List all Devices
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/devices
    docs: Lists Devices.
  - info:
      name: Retrieve a Device
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/devices/:device-id
    docs: Retrieves a Device.
- info:
    name: Documents
    type: folder
  items:
  - info:
      name: Retrieve a Document
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/documents/:document-id
    docs: Retrieves a Document collected during verification.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List all Webhooks
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/webhooks
    docs: Lists Webhooks.
  - info:
      name: Create a Webhook
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/webhooks
      body:
        type: json
        data: '{}'
    docs: Creates a Webhook subscription.
- info:
    name: Events
    type: folder
  items:
  - info:
      name: List all Events
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/events
    docs: Lists Events.
  - info:
      name: Retrieve an Event
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/events/:event-id
    docs: Retrieves an Event.
- info:
    name: Importers
    type: folder
  items:
  - info:
      name: List all Importers
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/importer
    docs: Lists Importers.
  - info:
      name: Retrieve an Importer
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/importer/:importer-id
    docs: Retrieves an Importer.
- info:
    name: Workflows
    type: folder
  items:
  - info:
      name: List all Workflow Runs
      type: http
    http:
      method: GET
      url: https://api.withpersona.com/api/v1/workflow-runs
    docs: Lists Workflow Runs.
  - info:
      name: Create a Workflow Run
      type: http
    http:
      method: POST
      url: https://api.withpersona.com/api/v1/workflow-runs
      body:
        type: json
        data: '{}'
    docs: Creates a Workflow Run.