--- title: "Get all relations for an Account" method: GET path: "/accounts/{account-id}/relations" tags: ["accounts"] --- # Get all relations for an Account `GET /accounts/{account-id}/relations` ## Request - Base URL: `https://api.withpersona.com/api/v1` - URL: `https://api.withpersona.com/api/v1/accounts/{account-id}/relations` - Auth: HTTP bearer Gets relations for an Account by key ## Path parameters - `account-id` string, required ## Query parameters - `include` string - `fields` object - `filter` AccountsAccountIdRelationsGetParametersFilter, required - `key` string, required: Filter relations by relation key. - `created-at-start` string: Filter relations by creation date. - `created-at-end` string: Filter relations by creation date. ## Headers - `Key-Inflection` 'camel' | 'kebab' | 'snake' - `Idempotency-Key` string - `Persona-Version` '2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18': Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). ## Response `200` This endpoint returns a collection of Account relations. - AccountsListAllRelationsResponse200 - `data` AccountsAccountIdRelationsGetResponsesContentApplicationJsonSchemaDataItems[], required: List of relations for the Account. The type of the returned objects is determined by the key query parameter. - union - Account: An Account object. Note that `fields` is **not** key inflected. - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributes - `reference-id` string, nullable - `account-type-name` string - `created-at` string, date-time - `updated-at` string, date-time - `redacted-at` string, date-time, nullable - `fields` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFields: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Account Type for this Account. Keys in `fields` are **not** key inflected. - `name` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsName - … - `address` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsAddress - … - `identification_numbers` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsIdentificationNumbers - … - `birthdate` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsBirthdate - … - `phone_number` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsPhoneNumber - … - `email_address` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsEmailAddress - … - `selfie_photo` VerificationIncludedObjectsItemsDiscriminatorMappingAccountAttributesFieldsSelfiePhoto - … - `tags` string[] - `account-status` string - `birthdate` string, date, nullable: Birthdate, must be in the format "YYYY-MM-DD". - `name-first` string, nullable: Given or first name. - `name-middle` string, nullable: Middle name. - `name-last` string, nullable: Family or last name. - `phone-number` string, nullable: Phone number. - `email-address` string, nullable: Email address. - `address-street-1` string, nullable: Street name of residence address. - `address-street-2` string, nullable: Extension of residence address, usually apartment or suite number. - `address-city` string, nullable: City of residence address. Not all international addresses use this attribute. - `address-subdivision` string, nullable: State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. - `address-postal-code` string, nullable: ZIP or postal code of residence address. Not all international addresses use this attribute. - `country-code` string, nullable: ISO 3166-1 alpha 2 country code. - `identification-numbers` object: Keys will be the identification class - `social-security-number` string, nullable: Social security number. - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationships - `account-type` VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountType - `data` VerificationIncludedObjectsItemsDiscriminatorMappingAccountRelationshipsAccountTypeData - … - Transaction - `id` string: Unique identifier for this Transaction. Starts with `txn_`. - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionAttributes - `status` string - `reference-id` string, nullable - `fields` object: JSON key-value pairs of field name to field value. Exact schema depends on the configuration of the Transaction Type for this Transaction. - `tags` string[] - `signals` object: Risk signals computed for this Transaction, keyed by signal name. Only present for Transactions whose Transaction Type has Sentinel enabled; signals appear once the Sentinel session has been processed. Specific keys are not enumerated in the public spec and may be added or removed over time. Contact your Persona account team for more information. - `created-at` string, date-time - `updated-at` string, date-time, nullable - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationships - `reviewer` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewer: The entity that reviewed the transaction - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsReviewerData - … - `transaction-label` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabel - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionLabelData - … - `transaction-type` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionType - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsTransactionTypeData - … - `related-objects` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjects: Objects involved in this Transaction's related Workflow runs. - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsRelatedObjectsDataItems[] - … - `sentinel-sessions` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsSentinelSessions: The Sentinel sessions that collected device and network data for this Transaction. Present on every Transaction; `data` is empty unless the Transaction has one or more Sentinel sessions. - `data` VerificationIncludedObjectsItemsDiscriminatorMappingTransactionRelationshipsSentinelSessionsDataItems[] - … - `links` AccountsAccountIdRelationsGetResponsesContentApplicationJsonSchemaLinks, required - `prev` string, nullable, required: URL pointing to the previous page of data, or null if on the first page. - `next` string, nullable, required: URL pointing to the next page of data, or null if on the last page. ## Other responses - `400`: The request was unacceptable, often due to invalid parameters. - `401`: An invalid API key was provided. - `403`: The given API key doesn’t have permissions to perform the request or a quota has been exceeded. - `404`: The requested resource doesn’t exist. - `409`: The request conflicts with another request, often due to attempting to create a duplicate resource. - `422`: The request modifies the resource in an unacceptable way, often due to an invalid action or parameter. - `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. --- [API](https://skmtc.dev/withpersona/apis/withpersona-2.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-2/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-2/revisions/f1c78133b3b2?raw)