> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.withpersona.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server. # Retrieve a Government ID Verification GET https://api.withpersona.com/api/v1/verification/government-ids/{verification-id} Retrieve a government ID verification Reference: https://docs.withpersona.com/api-reference/verifications/government-id-verifications/retrieve-a-government-id-verification ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `verification-id` (string, required) ### Query parameters - `include` (string, optional) — A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details. - `fields` (map from string to string, optional) — Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details. ### Headers - `Key-Inflection` (enum, optional) — Determines casing for the API response. - Allowed values: `camel`, `kebab`, `snake` - `Idempotency-Key` (string, optional) — Ensures the request is idempotent. - `Persona-Version` (enum, optional) — Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning). - Allowed values: `2025-12-08`, `2025-10-27`, `2023-01-05`, `2022-09-01`, `2021-08-18`, `2021-07-05`, `2021-02-21`, `2020-05-18` ## Response ### 200 This endpoint returns a Government ID Verification object and (optionally) its related objects in `included`. - `data` (Government ID Verification, required) — A Government ID Verification ## Errors ### 400 Bad Request Error The request was unacceptable, often due to invalid parameters. - `errors` (list of VerificationGovernmentIdsVerificationIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 401 Unauthorized Error An invalid API key was provided. - `errors` (list of VerificationGovernmentIdsVerificationIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 403 Forbidden Error The given API key doesn’t have permissions to perform the request or a quota has been exceeded. - `errors` (list of VerificationGovernmentIdsVerificationIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 404 Not Found Error The requested resource doesn’t exist. - `errors` (list of VerificationGovernmentIdsVerificationIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ### 429 Too Many Requests Error Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. - `errors` (list of VerificationGovernmentIdsVerificationIdGetResponsesContentApplicationJsonSchemaErrorsItems, optional) ## Types ### Government ID Verification A Government ID Verification - `id` (string, optional) — The token of the verification - `attributes` (VerificationDiscriminatorMappingVerificationGovernmentIdAttributes, optional) - `relationships` (VerificationDiscriminatorMappingVerificationGovernmentIdRelationships, optional) ### VerificationGovernmentIdsVerificationIdGetResponsesContentApplicationJsonSchemaErrorsItems - `title` (string, optional) - `details` (string, optional) ### VerificationDiscriminatorMappingVerificationGovernmentIdAttributes - `address-city` (string, optional, nullable) — City of residence address. Not all international addresses use this attribute. - `address-postal-code` (string, optional, nullable) — ZIP or postal code of residence address. Not all international addresses use this attribute. - `address-street-1` (string, optional, nullable) — Street name of residence address. - `address-street-2` (string, optional, nullable) — Extension of residence address, usually apartment or suite number. - `address-subdivision` (string, optional, nullable) — State or subdivision of residence address. In the US, this should be the unabbreviated name. Not all international addresses use this attribute. - `back-photo-url` (string, optional, nullable) - `birthdate` (string, optional, nullable) - `birthplace` (string, optional, nullable) - `capture-method` (string, optional, nullable) - `capture-methods` (VerificationDiscriminatorMappingVerificationGovernmentIdAttributesCaptureMethods, optional, nullable) — Capture method for each side of the ID, keyed by side. - `checks` (list of VerificationSharedAttributesChecksItems, optional) - `completed-at` (datetime, optional, nullable) — The time the verification was completed in ISO 8601 format - `completed-at-ts` (integer, optional, nullable) — The time the verification was completed in Unix timestamp format - `country-code` (string, optional, nullable) — ISO 3166-1 alpha 2 country code. - `created-at` (datetime, optional) — The time the verification was created in ISO 8601 format - `created-at-ts` (integer, optional) — The time the verification was created in Unix timestamp format - `designations` (list of any, optional, nullable) - `document-number` (string, optional, nullable) - `endorsements` (string, optional, nullable) - `entity-confidence-reasons` (list of string, optional) - `entity-confidence-score` (double, optional, nullable, default: 0) - `expiration-date` (string, optional, nullable) - `from-reusable-persona` (boolean, optional) - `front-photo-url` (string, optional, nullable) - `height` (string, optional, nullable) - `id-class` (string, optional, nullable) - `identification-number` (string, optional, nullable) - `issue-date` (string, optional, nullable) - `issuing-authority` (string, optional, nullable) - `issuing-subdivision` (string, optional, nullable) - `name-first` (string, optional, nullable) - `name-last` (string, optional, nullable) - `name-middle` (string, optional, nullable) - `name-suffix` (string, optional, nullable) - `nationality` (string, optional, nullable) - `native-name-first` (string, optional, nullable) — Native script given or first name. - `native-name-last` (string, optional, nullable) — Native script family or last name. - `native-name-middle` (string, optional, nullable) — Native script middle name. - `native-name-title` (string, optional, nullable) — Native script name title or prefix. - `photo-urls` (list of VerificationDiscriminatorMappingVerificationGovernmentIdAttributesPhotoUrlsItems, optional, nullable) - `redacted-at` (datetime, optional, nullable) — The time the verification was redacted in ISO 8601 format - `restrictions` (string, optional, nullable) - `selfie-photo` (VerificationDiscriminatorMappingVerificationGovernmentIdAttributesSelfiePhoto, optional, nullable) - `selfie-photo-url` (string, optional, nullable) - `sex` (string, optional, nullable) - `status` (string, optional) — The status of the verification Possible values: - initiated - submitted - tentatively_passed (only for `verification/document` and `verification/qes-infocert`) - tentatively_failed (only for `verification/database-business` and `verification/database-business-footprint`) - passed - failed - requires_retry - skipped - canceled - confirmed (only for `verification/email-address` and `verification/phone-number`) Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `submitted-at` (datetime, optional, nullable) — The time the verification was submitted in ISO 8601 format - `submitted-at-ts` (integer, optional, nullable) — The time the verification was submitted in Unix timestamp format - `tags` (list of string, optional) — Tags on the verification - `vehicle-class` (string, optional, nullable) - `vehicle-classes` (map from string to VerificationDiscriminatorMappingVerificationGovernmentIdAttributesVehicleClasses, optional, nullable) — Issue and expiration dates for each vehicle class extracted from a driving license (e.g. European licenses). Keys are the class identifiers exactly as they appear on the license, including national classes. - `video-url` (string, optional, nullable) - `visa-status` (string, optional, nullable) - `driver-license-number` (string, optional, nullable, deprecated) - `passport-number` (string, optional, nullable, deprecated) ### VerificationDiscriminatorMappingVerificationGovernmentIdRelationships - `accounts` (VerificationSharedRelationshipsAccounts, optional) - `document` (VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocument, optional) - `inquiry` (VerificationSharedRelationshipsInquiry, optional) — The inquiry linked to the verification - `inquiry-template` (VerificationSharedRelationshipsInquiryTemplate, optional) - `inquiry-template-version` (VerificationSharedRelationshipsInquiryTemplateVersion, optional) - `template` (VerificationSharedRelationshipsTemplate, optional) - `transaction` (VerificationSharedRelationshipsTransaction, optional) - `verification-template` (VerificationSharedRelationshipsVerificationTemplate, optional) - `verification-template-version` (VerificationSharedRelationshipsVerificationTemplateVersion, optional) ### VerificationDiscriminatorMappingVerificationGovernmentIdAttributesCaptureMethods Capture method for each side of the ID, keyed by side. - `front` (string, optional, nullable) - `back` (string, optional, nullable) ### VerificationSharedAttributesChecksItems - `name` (string, optional) - `status` (string, optional) — Possible values: - passed - failed - not_applicable Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `category` (string, optional, nullable) — The category assigned to the check. Possible values include: - biometrics - fraud - user_action_required - validity This categorizes the check itself, not its outcome. A null category means the check is uncategorized or its category is unknown; it must not be interpreted as non-fraud. Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `reasons` (list of string, optional) — If applicable, reasons are the list of reasons explaining why the check failed or is not applicable. For some checks, `reasons` is the primary signal carrying the underlying detection results. For example, `business_website_malicious_website_detection` surfaces its IPQS and Google Web Risk signals here (e.g. `malware`, `phishing`, `spam-source`) rather than in `metadata`. - `requirement` (string, optional) — Possible values: - required - not_required - requires_retry Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `metadata` (map from string to any, optional) — This is a free-form object containing relevant metadata to the processing and result of the check. ### VerificationDiscriminatorMappingVerificationGovernmentIdAttributesPhotoUrlsItems - `byte-size` (integer, optional, default: 0) - `filename` (string, optional) - `normalized-url` (string, optional) - `original-urls` (list of string, optional) - `page` (string, optional) - `url` (string, optional) ### VerificationDiscriminatorMappingVerificationGovernmentIdAttributesSelfiePhoto - `byte-size` (integer, optional, default: 0) - `filename` (string, optional) - `url` (string, optional) ### VerificationDiscriminatorMappingVerificationGovernmentIdAttributesVehicleClasses - `issue-date` (string, optional, nullable) - `expiration-date` (string, optional, nullable) ### VerificationSharedRelationshipsAccounts - `data` (list of VerificationSharedRelationshipsAccountsDataItems, optional) ### VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocument - `data` (VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocumentData, optional) ### VerificationSharedRelationshipsInquiry The inquiry linked to the verification - `data` (VerificationSharedRelationshipsInquiryData, optional, nullable) ### VerificationSharedRelationshipsInquiryTemplate - `data` (VerificationSharedRelationshipsInquiryTemplateData, optional, nullable) ### VerificationSharedRelationshipsInquiryTemplateVersion - `data` (VerificationSharedRelationshipsInquiryTemplateVersionData, optional, nullable) ### VerificationSharedRelationshipsTemplate - `data` (VerificationSharedRelationshipsTemplateData, optional, nullable) ### VerificationSharedRelationshipsTransaction - `data` (VerificationSharedRelationshipsTransactionData, optional, nullable) ### VerificationSharedRelationshipsVerificationTemplate - `data` (VerificationSharedRelationshipsVerificationTemplateData, optional, nullable) ### VerificationSharedRelationshipsVerificationTemplateVersion - `data` (VerificationSharedRelationshipsVerificationTemplateVersionData, optional, nullable) ### VerificationSharedRelationshipsAccountsDataItems - `id` (string, optional) - `type` ("account", optional) ### VerificationDiscriminatorMappingVerificationGovernmentIdRelationshipsDocumentData - `id` (string, optional) - `type` (string, optional) ### VerificationSharedRelationshipsInquiryData - `id` (string, optional) - `type` ("inquiry", optional) ### VerificationSharedRelationshipsInquiryTemplateData - `type` ("inquiry-template", optional) - `id` (string, optional) ### VerificationSharedRelationshipsInquiryTemplateVersionData - `type` ("inquiry-template-version", optional) - `id` (string, optional) ### VerificationSharedRelationshipsTemplateData - `type` ("template", optional) - `id` (string, optional) ### VerificationSharedRelationshipsTransactionData - `type` ("transaction", optional) - `id` (string, optional) ### VerificationSharedRelationshipsVerificationTemplateData - `type` (string, optional) - `id` (string, optional) ### VerificationSharedRelationshipsVerificationTemplateVersionData - `type` (string, optional) - `id` (string, optional) ## Examples **Response** ```json { "data": { "id": "ver_ABC123", "attributes": { "address-city": "SAN FRANCISCO", "address-postal-code": "94111", "address-street-1": "123 MAIN ST", "address-street-2": null, "address-subdivision": "CA", "back-photo-url": null, "birthdate": "1990-01-01", "birthplace": null, "capture-method": "upload", "capture-methods": { "front": "upload", "back": null }, "checks": [], "completed-at": "2024-03-20T21:22:31.000Z", "completed-at-ts": 1710969751, "country-code": "US", "created-at": "2024-03-20T21:22:25.000Z", "created-at-ts": 1710969745, "designations": [], "document-number": null, "endorsements": null, "entity-confidence-reasons": [ "generic" ], "entity-confidence-score": 96.1831512451172, "expiration-date": "2025-01-01", "from-reusable-persona": false, "front-photo-url": "https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN", "height": null, "id-class": "dl", "identification-number": "Y123ABC", "issue-date": "2020-07-28", "issuing-authority": null, "issuing-subdivision": "CA", "name-first": "JANE", "name-last": "DOE", "name-middle": null, "name-suffix": null, "nationality": null, "native-name-first": "三", "native-name-last": "张", "native-name-middle": null, "native-name-title": null, "photo-urls": [ { "byte-size": 2849115, "filename": "id-front.jpg", "normalized-url": "https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN", "original-urls": [ "https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN" ], "page": "front", "url": "https://files.withpersona.com/id-front.jpg?access_token=ACCESS_TOKEN" } ], "restrictions": null, "selfie-photo": { "byte-size": 201105, "filename": "selfie-photo.jpg", "url": "https://files.withpersona.com/selfie-photo.jpg?access_token=ACCESS_TOKEN" }, "selfie-photo-url": "https://files.withpersona.com/selfie-photo.jpg?access_token=ACCESS_TOKEN", "sex": null, "status": "passed", "submitted-at": "2024-03-20T21:22:25.000Z", "submitted-at-ts": 1710969745, "vehicle-class": null, "vehicle-classes": { "AM": { "issue-date": "2020-09-27T00:00:00", "expiration-date": null }, "B": { "issue-date": "2020-09-27T00:00:00", "expiration-date": "2035-09-27T00:00:00" }, "L": { "issue-date": "2020-09-27T00:00:00", "expiration-date": null } }, "video-url": null, "visa-status": null, "driver-license-number": "D1234562" }, "relationships": { "document": { "data": { "id": "doc_ABC123", "type": "document/government-id" } }, "inquiry": { "data": { "id": "inq_ABC123", "type": "inquiry" } }, "inquiry-template": { "data": { "type": "inquiry-template", "id": "itmpl_ABC123" } }, "inquiry-template-version": { "data": { "type": "inquiry-template-version", "id": "itmplv_ABC123" } }, "template": { "data": null }, "transaction": { "data": null }, "verification-template": { "data": { "type": "verification-template/government-id", "id": "vtmpl_ABC123" } }, "verification-template-version": { "data": { "type": "verification-template-version/government-id", "id": "vtmplv_ABC123" } } }, "type": "verification/government-id" } } ``` **SDK Code** ```python Success import requests url = "https://api.withpersona.com/api/v1/verification/government-ids/verification-id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Success const url = 'https://api.withpersona.com/api/v1/verification/government-ids/verification-id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Success package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.withpersona.com/api/v1/verification/government-ids/verification-id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Success require 'uri' require 'net/http' url = URI("https://api.withpersona.com/api/v1/verification/government-ids/verification-id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Success import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.withpersona.com/api/v1/verification/government-ids/verification-id") .header("Authorization", "Bearer ") .asString(); ``` ```php Success request('GET', 'https://api.withpersona.com/api/v1/verification/government-ids/verification-id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Success using RestSharp; var client = new RestClient("https://api.withpersona.com/api/v1/verification/government-ids/verification-id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Success import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.withpersona.com/api/v1/verification/government-ids/verification-id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```