On this page
No Headings
An array of documents that uniquely identify the user, such as a license number, social security number, and so on.
arrayitemsobjectThe authority-issued identification document. Document types include a driver's license, social security number, employee ID number, and so on.
typerequiredstring"SOCIAL_SECURITY_NUMBER", "EMPLOYMENT_IDENTIFICATION_NUMBER", "TAX_IDENTIFICATION_NUMBER", "PASSPORT_NUMBER", "PENSION_FUND_ID", "MEDICAL_INSURANCE_ID", "CNPJ", "CPF", "PAN", "NATIONAL_ID_CARD", "BUSINESS_REGISTRATION"The identifier type in the onboarding domain. Indicates the most specific type or the closest matching value. For example, SOCIAL_SECURITY_NUMBER in preference to TAX_IDENTIFICATION_NUMBER.
valuerequiredstring^[A-Za-z0-9]+$The identifier value, such as license number, social security number, and so on.
partial_valuerequiredbooleanfalseIndicates whether the value is a partial value. Specify this value when the identifier type supports a partial value, such as four SSN digits instead of the full nine values. Depending on the context, this parameter can be ignored.
issuer_country_coderequiredstring^[A-Z]([A-Z]|\d)$The two-character ISO-3166-1 country code for the country that issued the document.