Extracts sex and place of birth from ID documents

What’s new

Adds the sex, unparsed_sex and unparsed_place_of_birth fields to the Verification Report in the document section. If a document doesn’t contain this information, the corresponding value is null. For example, while passports usually include both sex and place of birth, a driver’s license might include sex but have a null value for unparsed_place_of_birth.

We recommend using sex because it’s parsed into an enum; however, you can use unparsed_sex if you need the raw value.

These fields are also available in the Verification Session for the last verification report and in the verified outputs.

Because these fields contain sensitive information, in order to retrieve them you need to use a restricted API key and explicitly expand them. For example, to retrieve the sex and unparsed_place_of_birth fields, follow the steps to retrieve sensitive verification results. The response might look like this:

{
  "id": "vs_",
  "object": "identity.verification_session",
  ...
  "verified_outputs": {
    "first_name": "Jenny",
    "last_name": "Rosen",
    ...
    "sex": "female",
    "unparsed_place_of_birth": "U.S.A."
  }
}

Impact

Platforms that need sex or place of birth information to fulfill additional KYC requirements, such as reporting them to an external agency, can now retrieve them using the Identity API.

Changes

Upgrade