--- title: "Person data" slug: "v1sessionsidperson-1" updated: 2026-04-24T06:39:53Z published: 2026-04-24T06:39:53Z --- > ## Documentation Index > Fetch the complete documentation index at: https://devdocs.veriff.com/llms.txt > Use this file to discover all available pages before exploring further. # Person data Get/v1/sessions/{id}/person ### Returns information objects about a person associated with the specific session ID #### When to use this endpoint - Use this endpoint to retrieve comprehensive information about a person - Common use cases include: - Accessing person's data for record-keeping or compliance purposes - Investigating potential PEP or sanctions matches flagged during verification (for example, when using Veriff's [AML screening solution](https://devdocs.veriff.com/v1/docs/aml-screening)) - Obtaining provider-specific match data including match confidence, source information, and associated records - Conducting enhanced due diligence based on screening results #### Response data - The response can include person data such as name, date of birth, nationality, and identification number, that have been extracted or input via initData. - When PEP or sanctions matches are found, the `pepSanctionMatches` array contains detailed match information from screening providers including: - Match confidence and match types - Source databases and listings - Associated persons and alternative names - Media references and supporting documentation - If no matches are found in PEP or sanctions databases, the `pepSanctionMatches` array will be empty. #### Note about "matchTypes", "matchTypeDetails" and "score" fields - Match results include `matchTypes`, `matchTypesDetails`, and `score` fields that indicate why and how strongly a match occurred. - These values are provided by the screening data provider and reflect their matching algorithms and confidence calculations. **Veriff returns this data as provided by the screening provider without modification**. - For `matchTypes`, see the [data provider's documentation](https://docs.complyadvantage.com/api-docs/?json#example-response-1) for more detailed info. - It returns the first value that is true from the following values: `name_exact`, `aka_exact`, `name_fuzzy`, `aka_fuzzy`, `phonetic_name`, `phonetic_aka`, `equivalent_name`, `equivalent_aka`, `unknown`. - If appropriate, the secondary match type is returned: `year_of_birth`, `removed_personal_title`, `removed_personal_suffix`, `removed_organisation_prefix`, `removed_organisation_suffix`, `removed_clerical_mark`. - For `matchTypeDetails`, see the [data provider's documentation](https://docs.complyadvantage.com/api-docs/?json#match-types-details) for more detailed info. - The `matchTypeDetails` field contains a detailed breakdown of why a hit occurred. For every name you matched on an entity, it will indicate how each term from your search matched it, as well other information about that name. - The `score` field gives a relative indication of match relevance as calculated by the data provider, not an absolute ranking. For more information see the entry in the [API FAQ article](https://devdocs.veriff.com/apidocs/api-faq#what-does-the-score-parameter-indicate-in-get-person-endpoint-response-and-how-should-it-be-used). #### Null and missing fields - Fields may be `null`, empty, or omitted depending on integration configuration and data availability: - `null` = field is included in payload but has no value (data unavailable, feature disabled, or verification declined/expired) - Empty (`{}` or `[]`) = field is included but returned no data (feature enabled but no results) - Omitted = field not part of payload (integration configuration or no results returned) - Always check field existence and `null` values before processing. #### Implementation notes - Always ensure that you use the correct API URL to send requests. See the [API URL section](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#api-url) for more info. - This endpoint requires session-level [HMAC signature](https://devdocs.veriff.com/docs/hmac-authentication-and-endpoint-security#public-api-v1) authentication - Person data is only available after the verification session has been submitted - The `pepSanctionMatches` array is populated only when AML screening has been enabled for your integration and matches are found - Handle `null` values gracefully - The order of parameters in the real API response can differ from the order you see in this documentation. This is expected and part of the [Backwards compatible changes](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#backwards-compatible-changes) requirements. Header parametersX-AUTH-CLIENTstringRequired Your integration's API key (occasionally referred to as the "Token", "API public key" or "Publishable key"). Required for all API requests. You can find your API key in the Veriff Customer Portal > Settings > API keys. X-HMAC-SIGNATUREstringRequired Session ID signed with the shared secret key. Required to authenticate the request sender. Path parametersidstring (uuid) Required Verification session ID. Responses200 Person data HeadersContent-TypestringResponse content type.Exampleapplication/json X-AUTH-CLIENTstringAPI key echoed back in response. X-HMAC-SIGNATUREstringResponse body signed with the shared secret key. Required to authenticate the response sender. no_pep_matches Person data with no PEP or sanctions matches Response when person data is available but no matches were found in PEP or sanctions databases ```json { "status": "success", "person": { "id": "b00a203e-2524-4ded-867b-b4e281a2c96b", "firstName": "MUAMMAR GADDAFI", "lastName": null, "idCode": "062.449.269-94", "dateOfBirth": "1942-09-22T00:00:00Z", "gender": "M", "nationality": "LY", "placeOfBirth": null, "citizenships": null, "pepSanctionMatches": [] } } ``` with_pep_match Person data with PEP match found Response showing complete PEP match structure including provider data, match details, sources, and associated information ```json { "status": "success", "person": { "id": "b00a203e-2524-4ded-867b-b4e281a2c96b", "firstName": "MUAMMAR GADDAFI", "lastName": null, "idCode": "062.449.269-94", "dateOfBirth": "1942-09-22T00:00:00Z", "gender": "M", "nationality": "LY", "placeOfBirth": null, "citizenships": null, "pepSanctionMatches": [ { "provider": "Comply Advantage", "numberOfMatches": 1, "date": "2018-04-18T11:02:05.261Z", "matches": [ { "name": "Mouammar Mohammed Abu Minyar Kadhafi", "nationality": "LIBYAN", "category": "PEP" } ], "hits": [ { "doc": { "id": "4KJL9THDX9ZNV4W", "lastUpdatedUtc": "2018-04-18T11:02:05.261Z", "createdUtc": "2018-04-18T11:02:05.261Z", "fields": [ { "name": "Original Place of Birth Text", "source": "world-bank-star-asset-recovery-watch", "value": "European Union", "tag": "origins", "locale": "EN" } ], "types": [ "pep" ], "name": "Mouammar Mohammed Abu Minyar Kadhafi", "entityType": "person", "aka": [ { "name": "Muammer al Gaddafi" } ], "associates": [ { "association": "spouse", "name": "Fatiha al-Nuri" } ], "sources": [ "argentina-ministerio-de-relaciones-exteriores-y-culto-sanciones-de-la-onu", "belarus-state-security-agency-list-of-organizations-and-individuals-involved-in-terrorist-activities" ], "keywords": [], "media": [ { "date": "2022-04-18T11:02:05.261Z", "snippet": "Sang Tan Judges in the High Court in London have ruled that Saleh Ibrahim Mabrouk, a former aide of Libyan leader Colonel Muammar Gaddafi, was partly to blame for the murder of PC Yvonne Fletcher. The gunman", "title": "Justice at Last - Former Gaddafi Aide Found Liable for 1984 Police Officer Murder by UK High Court", "url": "https://sputniknews.com/amp/20211116/justice-at-last-former-gaddafi-aide-found-liable-for-1984-police-officer-murder-by-uk-high-court-1090775876.html" } ], "assets": [ { "publicURL": "http://complyadvantage-asset.s3.amazonaws.com/76993a49-2d1e-4397-9e35-1e20f2b7dfa8.pdf", "source": "world-bank-star-asset-recovery-watch", "type": "pdf" } ], "sourceNotes": [ { "amlTypes": [ "sanction" ], "countryCodes": [ "AR" ], "listingStartedUtc": "2019-09-26T00:00:00Z", "name": "Argentina Ministerio de Relaciones Exteriores y Culto Sanciones de la ONU", "url": "https://www.cancilleria.gob.ar/es/politica-exterior/seguridad-internacional/comite-de-sanciones" } ], "matchTypes": [ "name_exact", "year_of_birth" ], "matchTypesDetails": [ { "matchTypes": "matching_name", "type": "exact_match" } ], "matchStatus": "potential_match", "isWhiteListed": false, "score": 24.46217 } } ] } ] } } ``` Expand Allobject statusstring API request status. Examplesuccess personobject List of objects identifying the person associated with the search term. idstring (uuid) The unique identifier of the person. Exampleb00a203e-2524-4ded-867b-b4e281a2c96b firstNamestring | null Person's first name. ExampleMUAMMAR GADDAFI lastNamestring | null Person's last name. Example idCodestring Person's ID number. Example062.449.269-94 dateOfBirthstring (date) Person's date of birth. Format: YYYY-MM-DD. Example1942-09-22 genderstring | null Person's gender. Valid values[ "M (male)", "F (female)", "`null` (undefined)" ]ExampleM nationalitystring (ISO 3166-1 Alpha-2) | null Person's nationality (country code, in capital letters). ExampleLY placeOfBirthstring | null Person's birth place. Example citizenshipsstring | null Deprecated Always returns empty array. Example pepSanctionMatches Array of object (PersonPepSanctionMatches) Array of objects identifying the PEP and Sanction values associated with the person. The array is empty if there are no hits in the database. object providerstring Name of the data provider that identified the PEP and Sanctions match. ExampleComply Advantage numberOfMatchesnumber (integer) The total number of PEP and Sanctions matches found. Example1.0 datestring (date-time) The date when the PEP and Sanctions match was identified. As combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ. Example2018-04-18T11:02:05.261Z matches Array of object (PepSanctionMatchesItem) Array listing the results that match the search term. object namestring The name of the person matched in the PEP and Sanctions list. ExampleMouammar Mohammed Abu Minyar Kadhafi nationalitystring The nationality of the person matched in the PEP and Sanctions list. ExampleLIBYAN categorystring The category of the PEP and Sanctions match, SIP (Special Interest Person) or PEP (Politically Exposed Person). Valid values[ "PEP", "SIP" ]ExamplePEP hits Array of object (PepSanctionMatchesHits) Array of objects listing results that match the search term. object docobject List of attributes identifying the info in the document about the person. idstring Document number, [a-zA-Z0-9] characters only. Example4KJL9THDX9ZNV4W lastUpdatedUtcstring (date-time) The date when the PEP and Sanctions match was recently updated. As combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ. Example2018-04-18T11:02:05.261Z createdUtcstring (date-time) The date when the PEP and Sanctions match was created. As combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ. Example2018-04-18T11:02:05.261Z fields Array of object (PepSanctionMatchesHitsDocFields) Array of objects describing the document fields. object namestring Name of the document field. ExampleOriginal Place of Birth Text sourcestring Source of the information in the document. Exampleworld-bank-star-asset-recovery-watch valuestring Value in the document field. ExampleEuropean Union tagstring Tag related to the name object. Exampleorigins localestring Language. ExampleEN types Array of string Array of match types names as defined by the data provider. Example[ "adverse-media-v2-other-serious" ]string Valid values[ "adverse-media", "adverse-media-v2-cybercrime", "adverse-media-v2-financial-aml-cft", "adverse-media-v2-financial-difficulty", "adverse-media-v2-fraud-linked", "adverse-media-v2-general-aml-cft", "adverse-media-v2-narcotics-aml-cft", "adverse-media-v2-other-minor", "adverse-media-v2-other-serious", "adverse-media-v2-property", "adverse-media-v2-terrorism", "adverse-media-v2-violence-aml-cft", "adverse-media-v2-violence-non-aml-cft", "pep", "pep-class-1", "pep-class-2", "sanction", "warning" ] namestring Person's name in the document. ExampleMouammar Mohammed Abu Minyar Kadhafi entityTypestring Type of the entity Valid values[ "person" ]Exampleperson aka Array of object (PepSanctionMatchesHitsDocAka) Array of objects listing the alternative names of the person. object namestring Person's alternative name. ExampleMuammer al Gaddafi, োৱাম্মাৰ গাড্ডাফি associates Array of object (PepSanctionMatchesHitsDocAssociates) Array of objects identifying associates of the person. object associationstring Type of association (relationship). Examplespouse namestring Associate's name. ExampleFatiha al-Nuri sources Array of array Info about the information sources. Example[ "argentina-ministerio-de-relaciones-exteriores-y-culto-sanciones-de-la-onu", "belarus-state-security-agency-list-of-organizations-and-individuals-involved-in-terrorist-activities" ]Array keywords Array of array Deprecated Always returns an empty array. Example[]Array media Array of object (PepSanctionMatchesHitsDocMedia) Array of objects containing media files about the person. object datestring (date-time) Media file date info. As combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ. Example2022-04-18T11:02:05.261Z snippetstring Text snippet about the person. ExampleSang Tan Judges in the High Court in London have ruled that Saleh Ibrahim Mabrouk, a former aide of Libyan leader Colonel Muammar Gaddafi, was partly to blame for the murder of PC Yvonne Fletcher. The gunman titlestring Title of the media file. ExampleJustice at Last - Former Gaddafi Aide Found Liable for 1984 Police Officer Murder by UK High Court - 16.11.2021, Sputnik International urlstring Web address to the media. Examplehttps://sputniknews.com/amp/20211116/justice-at-last-former-gaddafi-aide-found-liable-for-1984-police-officer-murder-by-uk-high-court-1090775876.html assets Array of object (PepSanctionMatchesHitsDocAssets) Array listing the info about media sources. object publicURLstring Web address. Examplehttp://complyadvantage-asset.s3.amazonaws.com/76993a49-2d1e-4397-9e35-1e20f2b7dfa8.pdf sourcestring Name of the source. Exampleworld-bank-star-asset-recovery-watch typestring File format. Examplepdf sourceNotes Array of object (PepSanctionMatchesHitsDocSourceNotes) List of attributes identifying the information source. Example[ "argentinaMinisterioDeRelacionesExterioresYCultoSancionesDeLaOnu" ]object amlTypes Array of string List of types as defined by the data provider. Example[ "sanction" ]string countryCodes Array of string Country code capital letters, as ISO 1366-1 Alpha-2 code. Example[ "AR" ]string listingStartedUtcstring (date-time) Starting date info about the source. As combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ. Example2017-09-26T08:12:34.567Z namestring Name of the info source. ExampleArgentina Ministerio de Relaciones Exteriores y Culto Sanciones de la ONU urlstring Web address of the info source. Examplehttps://www.cancilleria.gob.ar/es/politica-exterior/seguridad-internacional/comite-de-sanciones matchTypes Array of string Info about which data was matched. Example[ "name_exact", "year_of_birth" ]string Valid values[ "name_exact", "aka_exact", "name_fuzzy", "aka_fuzzy", "phonetic_name", "phonetic_aka", "equivalent_name", "equivalent_aka", "unknown", "year_of_birth", "removed_personal_title", "removed_personal_suffix", "removed_organisation_prefix", "removed_organisation_suffix", "removed_clerical_mark" ] matchTypesDetails Array of object (PepSanctionMatchesHitsMatchTypesDetails) List of more detailed breakdown of why a match happened. object matchTypesstring More detailed info about why a hit occurred, for example - `matching_name`, `sources`, `aml_types`, `name_matches, `secondary_matches`. Examplematching_name typestring Displays the type of the `match_type` that was matched. Exampleexact_match matchStatusstring Status of the match. Valid values[ "no_match", "false_positive", "potential_match", "true_positive", "unknown", "true_positive_approve", "true_positive_reject" ]Examplepotential_match isWhiteListedboolean Indicates whether the entity has been whitelisted. Availability depends on the configuration. Examplefalse scorenumber (decimal) The request results match and ranking is computed via a score that is included as part of the metadata. It is not an absolute ranking of the document, only giving some relative indication of relevance. This decimal value comes from the data provider. Example24.46217 400 Bad request HeadersContent-TypestringResponse content type.Exampleapplication/json X-AUTH-CLIENTstringAPI key echoed back in response. X-HMAC-SIGNATUREstringResponse body signed with the shared secret key. Required to authenticate the response sender. object statusstring Valid values[ "fail" ]Examplefail codestring Example1101 messagestring ExampleValidation failed 401 Unauthorized HeadersContent-TypestringResponse content type.Exampleapplication/json X-AUTH-CLIENTstringAPI key echoed back in response. X-HMAC-SIGNATUREstringResponse body signed with the shared secret key. Required to authenticate the response sender. object statusstring Valid values[ "fail" ]Examplefail codestring Example1101 messagestring ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request. 404 Session not found HeadersContent-TypestringResponse content type.Exampleapplication/json X-AUTH-CLIENTstringAPI key echoed back in response. X-HMAC-SIGNATUREstringResponse body signed with the shared secret key. Required to authenticate the response sender. object statusstring Valid values[ "fail" ]Examplefail codestring Example1101 messagestring ExampleResource not found 500 Internal server error HeadersContent-TypestringResponse content type.Exampleapplication/json X-AUTH-CLIENTstringAPI key echoed back in response. X-HMAC-SIGNATUREstringResponse body signed with the shared secret key. Required to authenticate the response sender. object statusstring Valid values[ "fail" ]Examplefail codestring Example1101 messagestring ExampleSomething went wrong Document Versioning **Changelog** | Date | Description | | --- | --- | | Apr 24, 2026 | Date and date-time parameters descriptions and examples standardized to UTC Z-only format and updated | | Apr 17, 2026 | Typo fixed | | Apr 1, 2026 | Typo fixed | | Mar 9, 2026 | Documentation updated: parent categories rearranged, intro section expanded, request and response examples added | | Oct 2, 2025 | `vrf-` headers removed from response headers | | Aug 6, 2025 | Response headers added | | Jun 27, 2025 | Added a note about the `score` parameter and a link to explanatory section in API FAQ article | | Mar 12, 2025 | Documentation published |