Persona

Run identity verification with Persona: create inquiries, send people the link, read the result, and approve or decline.

Actions

Action	What it does
Add a tag to an inquiry	Put one more tag on an inquiry, leaving its other tags alone.
Approve an inquiry	Approve an inquiry.
Create an account	Create the Persona account a person's inquiries and verifications hang off.
Create an inquiry	Start a verification for one person and get the link to send them.
Decline an inquiry	Decline an inquiry.
Expire an inquiry	Expire an inquiry and close its open sessions, cancelling any verification still in progress.
Get a one-time link	Create a fresh single-use link to an existing inquiry: the URL you send the person so they can complete it.
Get a verification	Get one verification (a single check inside an inquiry, such as a government ID or a selfie) with every check it ran and why each passed or failed.
Get an account	Get one account in full, with the details Persona holds on it.
Get an inquiry	Get one inquiry in full, including the data it collected and the ids of the verifications inside it.
List accounts	List the people Persona holds accounts for, newest first, optionally narrowed to your own ids for them.
List inquiries	List verification inquiries, newest first, narrowed by status, account, template or when they were created.
Mark an inquiry for review	Send an inquiry to your team's manual review queue.
Remove a tag from an inquiry	Take one tag off an inquiry, leaving its other tags alone.
Resume an inquiry	Reopen an inquiry and get a fresh session token for it.
Set account tags	Set the tags on an account.
Set inquiry tags	Set the tags on an inquiry.
Simulate inquiry actions	Move a Sandbox inquiry through its lifecycle without anyone completing the flow: the way to test a workflow end to end.
Update an account	Change the details on an account.
Update an inquiry	Change an inquiry's note, pre-filled details or tags.

Add a tag to an inquiry

Put one more tag on an inquiry, leaving its other tags alone.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Tag nametag_nametext: The tag's name. Give this or the tag id, not both.
Tag idtag_idtext: The tag's id. Give this or the tag name, not both.

Outputs

inquiryobject: The inquiry after tagging.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
statustext: Status of the action execution ("success" on success).
tagslist: The tags the inquiry now has.

Example output

{
  "inquiry": {
    "attributes": {
      "status": "created",
      "tags": [
        "signup",
        "priority"
      ]
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "created",
  "status": "success",
  "tags": [
    "signup",
    "priority"
  ]
}

Approve an inquiry

Approve an inquiry. This is final: Persona runs the account's workflows and webhooks and the inquiry cannot progress any further afterwards.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Commentcommenttext: An optional note recorded against the decision for auditing.

Outputs

inquiryobject: The inquiry after approval.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to, normally 'approved'.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "approved"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "approved",
  "status": "success"
}

Create an account

Create the Persona account a person's inquiries and verifications hang off. Filling in 'Match existing by' turns this into an update when one already matches.

Inputs

Account typeaccount_type_idtext: The account type to create this under (starts 'acttp_'). Leave blank for your organisation's default.
Your own id for this personreference_idtext: The id this person has in your own system. Persona stores it on the account so you can find them again without keeping Persona's id.
Account statusaccount_statustext: The name of a status configured on this account type, such as 'Approved'. Leave blank to use the account type's default.
Country codecountry_codetext: The person's country as a two-letter ISO code, such as US.
Tagstagslist: The complete set of tags the account should end up with. Filling this in replaces the account's existing tags; leave it blank to leave them alone.
Custom fieldsfieldsobject: Any extra fields your account type defines, as a name-to-value object. Leave blank unless your account type has custom fields.
Match existing byupsert_bytext: The field name to match an existing account on, such as reference-id. It must be unique across accounts of this type. Leave blank to always create a new account.
First namename_firsttext: The person's first name.
Middle namename_middletext: The person's middle name.
Last namename_lasttext: The person's last name.
Emailemail_addresstext: The person's email address.
Phonephone_numbertext: The person's phone number.
Date of birthbirthdatedate: The person's date of birth.
Street addressaddress_street_1text: The first line of the person's address.
Street address line 2address_street_2text: The second line of the person's address.
Cityaddress_citytext: The person's city.
State or provinceaddress_subdivisiontext: The person's state or province. In the US, write it out in full rather than abbreviating it.
Postal codeaddress_postal_codetext: The person's postal or ZIP code.

Outputs

accountobject: The account.
account_idtext: The account's id.
createdtrue/false: True when a new account was made, false when 'Match existing by' found one and updated it instead.
statustext: Status of the action execution ("success" on success).

Example output

{
  "account": {
    "attributes": {
      "account-type-name": "Individual",
      "reference-id": "customer-8821"
    },
    "id": "act_8nT2pQrLmX9WvKcBd4Zf",
    "type": "account"
  },
  "account_id": "act_8nT2pQrLmX9WvKcBd4Zf",
  "created": true,
  "status": "success"
}

Create an inquiry

Start a verification for one person and get the link to send them. Uses the inquiry template from your connection unless you name another one here.

Inputs

Templateinquiry_template_idtext: The inquiry template to run (starts 'itmpl_'). Leave blank to use the one set on your Persona connection.
Template versioninquiry_template_version_idtext: Pin the inquiry to one published version of a template (starts 'itmplv_'). Leave blank to use the template's current version.
Legacy templatetemplate_idtext: A Legacy 2.0 template (starts 'tmpl_'), for accounts still on the old flows. Use only one of the three template fields.
Accountaccount_idtext: Attach the inquiry to an existing account (starts 'act_'). Leave blank to let Persona create one.
Your own id for this personreference_idtext: The id this person has in your own system. Persona stores it on the account so you can find them again without keeping Persona's id.
Account typeaccount_type_idtext: The account type Persona should create the account as (starts 'acttp_'). Leave blank for your default type.
Create an account automaticallyauto_create_accounttrue/false: On (the default) creates an account for this person when none exists. Switch it off only if you are attaching an existing account -- Persona then rejects the two account fields above.Default: true.
Generate a link to sendauto_create_one_time_linktrue/false: On (the default) returns a one-time link you can email the person straight away.Default: true.
Generate a session tokenauto_create_inquiry_sessiontrue/false: Also return a session token, for embedding the flow in your own app rather than sending a link.Default: false.
Link expires after (seconds)one_time_link_expiration_secondsnumber: How long the one-time link stays usable. Leave blank for the template's own setting, which defaults to 24 hours.At least 1.
Redirect toredirect_uritext: Where to send the person's browser once they finish the hosted flow.
Created bycreator_email_addresstext: The email address recorded as having started this.
Notenotetext: A free-form note stored on the inquiry.
Tagstagslist: Tag names to put on the new inquiry.
First namename_firsttext: The person's first name, pre-filled into the inquiry.
Middle namename_middletext: The person's middle name.
Last namename_lasttext: The person's last name.
Emailemail_addresstext: The person's email address.
Phonephone_numbertext: The person's phone number.
Date of birthbirthdatedate: The person's date of birth.
Street addressaddress_street_1text: The first line of the person's address.
Street address line 2address_street_2text: The second line of the person's address.
Cityaddress_citytext: The person's city.
State or provinceaddress_subdivisiontext: The person's state or province. In the US, write it out in full rather than abbreviating it.
Postal codeaddress_postal_codetext: The person's postal or ZIP code.
Country codeaddress_country_codetext: The person's country as a two-letter ISO code, such as US.

Outputs

inquiryobject: The inquiry that was created.
inquiry_idtext: The new inquiry's id.
inquiry_statustext: Where the inquiry starts out, normally 'created'.
one_time_linktext: The link to send the person, when one was asked for. Empty otherwise.
one_time_link_shorttext: A shortened form of the same link.
session_tokentext: A session token for embedding the flow, when one was asked for. Empty otherwise.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "created",
      "tags": [
        "signup"
      ]
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "created",
  "one_time_link": "https://withpersona.com/verify?inquiry-id=inq_4eC39HqLyjWDarjtT1zdp7dc",
  "one_time_link_short": "https://withpersona.com/l/9fQ2xa",
  "session_token": "",
  "status": "success"
}

Decline an inquiry

Decline an inquiry. This is final: Persona runs the account's workflows and webhooks and the inquiry cannot progress any further afterwards.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Commentcommenttext: An optional note recorded against the decision for auditing.

Outputs

inquiryobject: The inquiry after the decline.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to, normally 'declined'.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "declined"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "declined",
  "status": "success"
}

Expire an inquiry

Expire an inquiry and close its open sessions, cancelling any verification still in progress. It can be resumed afterwards.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.

Outputs

inquiryobject: The inquiry after expiring.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to, normally 'expired'.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "expired"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "expired",
  "status": "success"
}

Get a one-time link

Create a fresh single-use link to an existing inquiry: the URL you send the person so they can complete it.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Expires after (seconds)expires_in_secondsnumber: How long the link stays usable. Leave blank for the template's own setting, which defaults to 24 hours.At least 1.

Outputs

inquiryobject: The inquiry the link is for.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
one_time_linktext: The single-use link to send the person.
one_time_link_shorttext: A shortened form of the same link.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "created"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "created",
  "one_time_link": "https://withpersona.com/verify?inquiry-id=inq_4eC39HqLyjWDarjtT1zdp7dc",
  "one_time_link_short": "https://withpersona.com/l/9fQ2xa",
  "status": "success"
}

Get one verification (a single check inside an inquiry, such as a government ID or a selfie) with every check it ran and why each passed or failed. Its id comes off an inquiry's verifications relationship.

Inputs

Verificationverification_idtextRequired: The verification's id, which starts 'ver_'. Get an inquiry and read it from its verifications relationship, or paste the dashboard address.

Outputs

checkslist: Every individual check, with its result and reasons.
statustext: Status of the action execution ("success" on success).
verificationobject: The verification, with its type-specific fields.
verification_idtext: The verification's id.
verification_statustext: Whether it passed, failed or is still running.
verification_typetext: Which kind of verification this is, such as verification/government-id.

Example output

{
  "checks": [
    {
      "name": "id_expired_detection",
      "reasons": [],
      "status": "passed"
    }
  ],
  "status": "success",
  "verification": {
    "attributes": {
      "checks": [
        {
          "name": "id_expired_detection",
          "reasons": [],
          "status": "passed"
        }
      ],
      "country-code": "US",
      "status": "passed"
    },
    "id": "ver_7kPq2mXnRt4YbVcLsD8W",
    "type": "verification/government-id"
  },
  "verification_id": "ver_7kPq2mXnRt4YbVcLsD8W",
  "verification_status": "passed",
  "verification_type": "verification/government-id"
}

Get an account

Get one account in full, with the details Persona holds on it.

Inputs

Accountaccount_idtextRequired: The account's id, which starts 'act_'. Use 'List accounts' to find one, or paste the account's dashboard address.

Outputs

accountobject: The account.
account_idtext: The account's id.
statustext: Status of the action execution ("success" on success).

Example output

{
  "account": {
    "attributes": {
      "account-type-name": "Individual",
      "reference-id": "customer-8821",
      "tags": [
        "signup"
      ]
    },
    "id": "act_8nT2pQrLmX9WvKcBd4Zf",
    "type": "account"
  },
  "account_id": "act_8nT2pQrLmX9WvKcBd4Zf",
  "status": "success"
}

Get an inquiry

Get one inquiry in full, including the data it collected and the ids of the verifications inside it.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.

Outputs

inquiryobject: The inquiry.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "completed",
      "tags": [
        "signup"
      ]
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "completed",
  "status": "success"
}

List accounts

List the people Persona holds accounts for, newest first, optionally narrowed to your own ids for them.

Inputs

Your own idsreference_idslist: Only return accounts recorded against these ids from your own system.
Maximum resultspage_sizenumber: How many results to return per page (1-100). Persona uses 10 by default.From 1 to 100.
Afterpage_aftertext: Return the page that follows this record. Persona pages by object id, so this is the id of the last record on the previous page.
Beforepage_beforetext: Return the page that precedes this record, given as an object id.

Outputs

accountslist: The accounts that matched, newest first.
countnumber: How many accounts were returned.
linksobject: Links to the previous and next pages, when there are any.
statustext: Status of the action execution ("success" on success).

Example output

{
  "accounts": [
    {
      "attributes": {
        "account-type-name": "Individual",
        "reference-id": "customer-8821",
        "tags": [
          "signup"
        ]
      },
      "id": "act_8nT2pQrLmX9WvKcBd4Zf",
      "type": "account"
    }
  ],
  "count": 1,
  "links": {
    "next": null,
    "prev": null
  },
  "status": "success"
}

List inquiries

List verification inquiries, newest first, narrowed by status, account, template or when they were created.

Inputs

Statusstatuseslist: Only return inquiries in these statuses.One or more of: created, pending, completed, expired, failed, needs_review (Needs review), approved, declined.
Accountsaccount_idslist: Only return inquiries belonging to these accounts.
Inquiriesinquiry_idslist: Only return these specific inquiries, by id.
Your own idreference_idtext: Only return inquiries recorded against this id from your own system.
Templateinquiry_template_idtext: Only return inquiries made from this template (starts 'itmpl_').
Legacy templatetemplate_idtext: Only return inquiries made from this legacy template (starts 'tmpl_').
Notenotetext: Only return inquiries carrying this note. Persona accepts this filter on its own, so clear the others when you use it.
Created fromcreated_at_startdate and time: Only return inquiries created at or after this time.
Created up tocreated_at_enddate and time: Only return inquiries created at or before this time.
Maximum resultspage_sizenumber: How many results to return per page (1-100). Persona uses 10 by default.From 1 to 100.
Afterpage_aftertext: Return the page that follows this record. Persona pages by object id, so this is the id of the last record on the previous page.
Beforepage_beforetext: Return the page that precedes this record, given as an object id.

Outputs

countnumber: How many inquiries were returned.
inquirieslist: The inquiries that matched, newest first.
linksobject: Links to the previous and next pages, when there are any.
statustext: Status of the action execution ("success" on success).

Example output

{
  "count": 1,
  "inquiries": [
    {
      "attributes": {
        "reference-id": "customer-8821",
        "status": "completed",
        "tags": [
          "signup"
        ]
      },
      "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
      "type": "inquiry"
    }
  ],
  "links": {
    "next": null,
    "prev": null
  },
  "status": "success"
}

Mark an inquiry for review

Send an inquiry to your team's manual review queue. The inquiry stops progressing until someone decides it.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.

Outputs

inquiryobject: The inquiry after being marked for review.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to, normally 'needs_review'.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "needs_review"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "needs_review",
  "status": "success"
}

Remove a tag from an inquiry

Take one tag off an inquiry, leaving its other tags alone.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Tag nametag_nametext: The tag's name. Give this or the tag id, not both.
Tag idtag_idtext: The tag's id. Give this or the tag name, not both.

Outputs

inquiryobject: The inquiry after untagging.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
statustext: Status of the action execution ("success" on success).
tagslist: The tags the inquiry now has.

Example output

{
  "inquiry": {
    "attributes": {
      "status": "created",
      "tags": [
        "signup"
      ]
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "created",
  "status": "success",
  "tags": [
    "signup"
  ]
}

Resume an inquiry

Reopen an inquiry and get a fresh session token for it. Persona only allows this while the inquiry is pending or expired.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.

Outputs

inquiryobject: The inquiry after resuming.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to, normally 'pending'.
session_tokentext: The new session token for the reopened inquiry.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "pending"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "pending",
  "session_token": "sess_9fQ2xaLmN8",
  "status": "success"
}

Set account tags

Set the tags on an account. This replaces its existing tags: any tag you leave out is removed, and an empty list clears them all.

Inputs

Accountaccount_idtextRequired: The account's id, which starts 'act_'. Use 'List accounts' to find one, or paste the account's dashboard address.
Tag namestag_nameslist: The complete set of tag names the record should end up with. To add one, include the existing tags too -- anything left out is removed.
Tag idstag_idslist: The complete set of tag ids the record should end up with, for tags you address by id rather than by name.

Outputs

accountobject: The account after the change.
account_idtext: The account's id.
statustext: Status of the action execution ("success" on success).
tagslist: The tags the account now has.

Example output

{
  "account": {
    "attributes": {
      "tags": [
        "signup"
      ]
    },
    "id": "act_8nT2pQrLmX9WvKcBd4Zf",
    "type": "account"
  },
  "account_id": "act_8nT2pQrLmX9WvKcBd4Zf",
  "status": "success",
  "tags": [
    "signup"
  ]
}

Set inquiry tags

Set the tags on an inquiry. This replaces its existing tags: any tag you leave out is removed, and an empty list clears them all.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Tag namestag_nameslist: The complete set of tag names the record should end up with. To add one, include the existing tags too -- anything left out is removed.
Tag idstag_idslist: The complete set of tag ids the record should end up with, for tags you address by id rather than by name.

Outputs

inquiryobject: The inquiry after the change.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
statustext: Status of the action execution ("success" on success).
tagslist: The tags the inquiry now has.

Example output

{
  "inquiry": {
    "attributes": {
      "status": "created",
      "tags": [
        "signup"
      ]
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "created",
  "status": "success",
  "tags": [
    "signup"
  ]
}

Simulate inquiry actions

Move a Sandbox inquiry through its lifecycle without anyone completing the flow: the way to test a workflow end to end. Sandbox only: a production API key is refused. The actions run in Persona's lifecycle order whichever order you tick them in.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Actions to simulatesimulate_actionslistRequired: What should happen to the inquiry. Each one fires the same events a real inquiry would.One or more of: start_inquiry (Start inquiry), create_passed_verification (Create passed verification), create_failed_verification (Create failed verification), complete_inquiry (Complete inquiry), fail_inquiry (Fail inquiry), expire_inquiry (Expire inquiry), mark_for_review_inquiry (Mark for review inquiry), approve_inquiry (Approve inquiry), decline_inquiry (Decline inquiry).
Verification templateverification_template_idtext: Only needed for the two 'create verification' actions: the token of the verification template to simulate, from Verifications > Templates in the dashboard.

Outputs

inquiryobject: The inquiry after the simulated actions.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
simulated_actionslist: The actions that were run, in the order they ran.
statustext: Status of the action execution ("success" on success).

Example output

{
  "inquiry": {
    "attributes": {
      "status": "completed"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "completed",
  "simulated_actions": [
    "start_inquiry",
    "complete_inquiry"
  ],
  "status": "success"
}

Update an account

Change the details on an account. Only the fields you fill in are changed, but filling in Tags replaces the account's whole tag set. An account's type cannot be changed.

Inputs

Accountaccount_idtextRequired: The account's id, which starts 'act_'. Use 'List accounts' to find one, or paste the account's dashboard address.
Your own id for this personreference_idtext: The id this person has in your own system. Persona stores it on the account so you can find them again without keeping Persona's id.
Account statusaccount_statustext: The name of a status configured on this account type, such as 'Approved'. Leave blank to use the account type's default.
Country codecountry_codetext: The person's country as a two-letter ISO code, such as US.
Tagstagslist: The complete set of tags the account should end up with. Filling this in replaces the account's existing tags; leave it blank to leave them alone.
Custom fieldsfieldsobject: Any extra fields your account type defines, as a name-to-value object. Leave blank unless your account type has custom fields.
First namename_firsttext: The person's first name.
Middle namename_middletext: The person's middle name.
Last namename_lasttext: The person's last name.
Emailemail_addresstext: The person's email address.
Phonephone_numbertext: The person's phone number.
Date of birthbirthdatedate: The person's date of birth.
Street addressaddress_street_1text: The first line of the person's address.
Street address line 2address_street_2text: The second line of the person's address.
Cityaddress_citytext: The person's city.
State or provinceaddress_subdivisiontext: The person's state or province. In the US, write it out in full rather than abbreviating it.
Postal codeaddress_postal_codetext: The person's postal or ZIP code.

Outputs

accountobject: The account after the update.
account_idtext: The account's id.
statustext: Status of the action execution ("success" on success).
updated_fieldslist: The names of the fields that were changed.

Example output

{
  "account": {
    "attributes": {
      "account-status": "Approved"
    },
    "id": "act_8nT2pQrLmX9WvKcBd4Zf",
    "type": "account"
  },
  "account_id": "act_8nT2pQrLmX9WvKcBd4Zf",
  "status": "success",
  "updated_fields": [
    "account-status"
  ]
}

Update an inquiry

Change an inquiry's note, pre-filled details or tags. Only the fields you fill in are changed, but filling in Tags replaces the inquiry's whole tag set.

Inputs

Inquiryinquiry_idtextRequired: The inquiry's id, which starts 'inq_'. Use 'List inquiries' to find one -- it is also the last part of the inquiry's web address in the Persona dashboard, which you can paste whole.
Notenotetext: A free-form note stored on the inquiry.
Redirect toredirect_uritext: Where to send the person's browser once they finish the hosted flow.
Tagstagslist: The complete set of tags the inquiry should end up with. Anything left out is removed; leave this blank to leave the tags alone.
First namename_firsttext: The person's first name, pre-filled into the inquiry.
Middle namename_middletext: The person's middle name.
Last namename_lasttext: The person's last name.
Emailemail_addresstext: The person's email address.
Phonephone_numbertext: The person's phone number.
Date of birthbirthdatedate: The person's date of birth.
Street addressaddress_street_1text: The first line of the person's address.
Street address line 2address_street_2text: The second line of the person's address.
Cityaddress_citytext: The person's city.
State or provinceaddress_subdivisiontext: The person's state or province. In the US, write it out in full rather than abbreviating it.
Postal codeaddress_postal_codetext: The person's postal or ZIP code.
Country codeaddress_country_codetext: The person's country as a two-letter ISO code, such as US.

Outputs

inquiryobject: The inquiry after the update.
inquiry_idtext: The inquiry's id.
inquiry_statustext: Where the inquiry has got to.
statustext: Status of the action execution ("success" on success).
updated_fieldslist: The names of the fields that were changed.

Example output

{
  "inquiry": {
    "attributes": {
      "note": "Priority review",
      "status": "created"
    },
    "id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
    "type": "inquiry"
  },
  "inquiry_id": "inq_4eC39HqLyjWDarjtT1zdp7dc",
  "inquiry_status": "created",
  "status": "success",
  "updated_fields": [
    "note"
  ]
}

ActionsCopy Anchor Link

Add a tag to an inquiryCopy Anchor Link

Inputs

Outputs

Approve an inquiryCopy Anchor Link

Inputs

Outputs

Create an accountCopy Anchor Link

Inputs

Outputs

Create an inquiryCopy Anchor Link

Inputs

Outputs

Decline an inquiryCopy Anchor Link

Inputs

Outputs

Expire an inquiryCopy Anchor Link

Inputs

Outputs

Get a one-time linkCopy Anchor Link

Inputs

Outputs

Get a verificationCopy Anchor Link

Inputs

Outputs

Get an accountCopy Anchor Link

Inputs

Outputs

Get an inquiryCopy Anchor Link

Inputs

Outputs

List accountsCopy Anchor Link

Inputs

Outputs

List inquiriesCopy Anchor Link

Inputs

Outputs

Mark an inquiry for reviewCopy Anchor Link

Inputs

Outputs

Remove a tag from an inquiryCopy Anchor Link

Inputs

Outputs

Resume an inquiryCopy Anchor Link

Inputs

Outputs

Set account tagsCopy Anchor Link

Inputs

Outputs

Set inquiry tagsCopy Anchor Link

Inputs

Outputs

Simulate inquiry actionsCopy Anchor Link

Inputs

Outputs

Update an accountCopy Anchor Link

Inputs

Outputs

Update an inquiryCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add a tag to an inquiry

Approve an inquiry

Create an account

Create an inquiry

Decline an inquiry

Expire an inquiry

Get a one-time link

Get a verification

Get an account

Get an inquiry

List accounts

List inquiries

Mark an inquiry for review

Remove a tag from an inquiry

Resume an inquiry

Set account tags

Set inquiry tags

Simulate inquiry actions

Update an account

Update an inquiry