Persona Developer Hub

Welcome to the Persona developer hub. You'll find comprehensive guides and documentation to help you start working with personaidentities as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Accounts

An accountaccount - An entity that captures all the interactions (i.e. inquiries) between an individual and an organization, typically representing an individual in the organization's system. acts as a mirror between the individuals in your system and the information in Persona. Accounts enable you to view the entire history of how you have interacted with an individual over time and act as an ongoing representation of that individual in the Persona system. As more information is collected for a individual, more information aggregates to the account. All inquiries, documents and reports are connected back to that account, and therefore to a specific individual.

When new inquiries on your system are created with a new reference ID, Persona will automatically create a new account associated with that reference ID.

📘

We recommend using your user ID as your Persona reference ID.

New Inquiries for reverification

To create a new inquiryinquiry - A single instance of an individual attempting to verify their identity.. associated with an account you can use either that account ID or the reference ID associated with that account combined with the template you'd like to use.

API_KEY=YOUR_API_KEY_HERE
curl -X POST -H 'Content-Type: application/json' -H "Authorization: Bearer $API_KEY" -d'{
  "data": {
    "type": "inquiry",
    "attributes": {
      "template-id": YOUR_TEMPLATE_ID,
      "account-id": ACCOUNT_ID
    }
  }
}' https://withpersona.com/api/v1/inquiries

📘

Reverification can be used to collect additional information on an existing individual or to reverify that information you originally collected is still valid!

Account Creation

Accounts can also be created without an Inquiry, either manually in your Persona dashboard or via the API.

Creating Accounts via API:

API_KEY=YOUR_API_KEY_HERE
curl -X POST -H 'Content-Type: application/json' -H "Authorization: Bearer $API_KEY" -d'{
  "data": {
    "type": "account",
    "attributes": {
      "reference-id": REFERENCE_ID
    }
  }
}' https://withpersona.com/api/v1/accounts

Importing Accounts

If you would like to import many accounts at once into Persona, you can upload a CSV of your account data. Note: this type of upload does not support images at this time.

API_KEY=YOUR_API_KEY_HERE
FILE_PATH=CSV_FILE_PATH
curl -X POST -H 'Content-Type: application/json' -H "Authorization: Bearer $API_KEY" -d'{
  "data": {
    "type": "importer",
    "attributes": {
      "file": { "data": "'"$(base64 $FILE_PATH)"'", "filename": "$FILE_PATH" }
    }
  }
}' https://withpersona.com/api/v1/importer/accounts

The information we support during bulk import are:

  • reference_id
  • name_first
  • name_middle
  • name_last
  • birthdate
  • social_security_number
  • tags

📘

Reference IDs are unique across accounts in Persona as they should map back to your users.

Continuous Reports

Reports can be configured to run in regular intervals against an Account. Please contact us or email [email protected] to set this up!

Updated 2 months ago

Accounts


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.