java.lang.Object
- com.nimbusds.oauth2.sdk.id.Identifier
- - com.nimbusds.openid.connect.sdk.assurance.evidences.DocumentType

All Implemented Interfaces:

Serializable, Comparable<Identifier>, net.minidev.json.JSONAware
```
@Immutable
public final class DocumentType
extends Identifier
```
Identity document type.
Related specifications:
- OpenID Connect for Identity Assurance 1.0, sections 5.1.1.1 and 14.
- https://bitbucket.org/openid/ekyc-ida/wiki/identifiers
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static DocumentType`	`ADOPTION_CERTIFICATE`	Official document certifying the circumstances of an adoption.
`static DocumentType`	`BANK_STATEMENT`	Bank statement from a recognised banking institution.
`static DocumentType`	`BIRTH_CERTIFICATE`	Official document certifying the circumstances of a birth.
`static DocumentType`	`DE_CERTIFICATE_OF_SUSPENSION_OF_DEPORTATION`	Identity document issued by the German government to refugees in case of suspension of deportation that are marked as "ID Card replacement".
`static DocumentType`	`DE_EMERGENCY_IDCARD`	ID Card issued by the German government to foreign nationals as passports replacement.
`static DocumentType`	`DE_ERP`	Electronic Resident Permit issued by the German government to foreign nationals.
`static DocumentType`	`DE_ERP_REPLACEMENT_IDCARD`	Electronic Resident Permit issued by the German government to foreign nationals as replacement for another identity document.
`static DocumentType`	`DE_IDCARD_APATRIDS`	ID Card issued by the German government to apatrids as passports replacement.
`static DocumentType`	`DE_IDCARD_FOREIGNERS`	ID Card issued by the German government to foreign nationals.
`static DocumentType`	`DE_IDCARD_REFUGEES`	ID Card issued by the German government to refugees as passports replacement.
`static DocumentType`	`DE_PERMISSION_TO_RESIDE`	Permission to reside issued by the German government to foreign nationals applying for asylum.
`static DocumentType`	`DE_REPLACEMENT_IDCARD`	ID Card replacement document issued by the German government to foreign nationals (see Act on the Residence, Economic Activity and Integration of Foreigners in the Federal Territory, Residence Act, Appendix D1 ID Card replacement according to § 48 Abs.
`static DocumentType`	`DRIVING_PERMIT`	Official document permitting an individual to operate motorized vehicles.
`static DocumentType`	`EDUCATION_CERTIFICATE`	Document certifying that a person has received specific education or has passed a test or series of tests.
`static DocumentType`	`FIREARM_PERMIT`	Official document permitting an individual to use or own a firearm.
`static DocumentType`	`GENDER_CERTIFICATE`	Official document certifying that a person has satisfied the criteria for legal recognition in the acquired gender.
`static DocumentType`	`IDCARD`	An identity document issued by a country's government for the purpose of identifying a citizen.
`static DocumentType`	`JP_DRIVERS_LICENSE`	Japanese drivers license.
`static DocumentType`	`JP_HEALTH_INSURANCE_CARD`	Japanese health insurance card.
`static DocumentType`	`JP_INDIVIDUAL_NUMBER_CARD`	Japanese national ID card.
`static DocumentType`	`JP_PERMANENT_RESIDENCY_CARD_FOR_FOREIGNER`	Japanese special residency card for foreigners to permit permanent residence.
`static DocumentType`	`JP_RESIDENCY_CARD`	Japanese residency card.
`static DocumentType`	`JP_RESIDENCY_CARD_FOR_FOREIGNER`	Japanese residence card for foreigners.
`static DocumentType`	`LOAN_STATEMENT`	Statement from a recognised loan provider.
`static DocumentType`	`MARRIAGE_CERTIFICATE`	Official document certifying the circumstances of a marriage.
`static DocumentType`	`MILITARY_ID`	An official military identity document issued by a country's government to its service personnel.
`static DocumentType`	`MORTGAGE_STATEMENT`	Statement from a recognised mortgage provider.
`static DocumentType`	`PASSPORT`	A passport is a travel document, usually issued by a country's government, that certifies the identity and nationality of its holder primarily for the purpose of international travel.
`static DocumentType`	`PILOT_PERMIT`	Official document permitting an individual to operate an aircraft.
`static DocumentType`	`RESIDENCE_PERMIT`	Official document permitting an individual to reside within a particular jurisdiction.
`static DocumentType`	`SOCIAL_SECURITY_STATEMENT`	Statement from a country's social security authority.
`static DocumentType`	`TAX_STATEMENT`	Statement from a country's tax authority.
`static DocumentType`	`UTILITY_STATEMENT`	Statement from a recognised utility provider.
`static DocumentType`	`VISA`	Document that grants the holder official permission to enter, leave or stay in a country.
`static DocumentType`	`VOTER_ID`	An official voter identity document.

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier
DEFAULT_BYTE_LENGTH, secureRandom

Constructor Summary

Constructors
Constructor Description

DocumentType(String value)
Creates a new identity document type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean equals(Object object)
- Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier
  compareTo, getValue, hashCode, toJSONString, toString, toStringList
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - IDCARD
```
public static final DocumentType IDCARD
```
    An identity document issued by a country's government for the purpose of identifying a citizen.
  - PASSPORT
```
public static final DocumentType PASSPORT
```
    A passport is a travel document, usually issued by a country's government, that certifies the identity and nationality of its holder primarily for the purpose of international travel.
  - DRIVING_PERMIT
```
public static final DocumentType DRIVING_PERMIT
```
    Official document permitting an individual to operate motorized vehicles. In the absence of a formal identity document, a driver's license may be accepted in many countries for identity verification.
  - RESIDENCE_PERMIT
```
public static final DocumentType RESIDENCE_PERMIT
```
    Official document permitting an individual to reside within a particular jurisdiction.
  - DE_IDCARD_FOREIGNERS
```
public static final DocumentType DE_IDCARD_FOREIGNERS
```
    ID Card issued by the German government to foreign nationals.
  - DE_EMERGENCY_IDCARD
```
public static final DocumentType DE_EMERGENCY_IDCARD
```
    ID Card issued by the German government to foreign nationals as passports replacement.
  - DE_ERP
```
public static final DocumentType DE_ERP
```
    Electronic Resident Permit issued by the German government to foreign nationals.
  - DE_ERP_REPLACEMENT_IDCARD
```
public static final DocumentType DE_ERP_REPLACEMENT_IDCARD
```
    Electronic Resident Permit issued by the German government to foreign nationals as replacement for another identity document.
  - DE_IDCARD_REFUGEES
```
public static final DocumentType DE_IDCARD_REFUGEES
```
    ID Card issued by the German government to refugees as passports replacement.
  - DE_IDCARD_APATRIDS
```
public static final DocumentType DE_IDCARD_APATRIDS
```
    ID Card issued by the German government to apatrids as passports replacement.
  - DE_CERTIFICATE_OF_SUSPENSION_OF_DEPORTATION
```
public static final DocumentType DE_CERTIFICATE_OF_SUSPENSION_OF_DEPORTATION
```
    Identity document issued by the German government to refugees in case of suspension of deportation that are marked as "ID Card replacement".
  - DE_PERMISSION_TO_RESIDE
```
public static final DocumentType DE_PERMISSION_TO_RESIDE
```
    Permission to reside issued by the German government to foreign nationals applying for asylum.
  - DE_REPLACEMENT_IDCARD
```
public static final DocumentType DE_REPLACEMENT_IDCARD
```
    ID Card replacement document issued by the German government to foreign nationals (see Act on the Residence, Economic Activity and Integration of Foreigners in the Federal Territory, Residence Act, Appendix D1 ID Card replacement according to § 48 Abs. 2 i.V.m. § 78a Abs. 4).
  - JP_DRIVERS_LICENSE
```
public static final DocumentType JP_DRIVERS_LICENSE
```
    Japanese drivers license.
  - JP_RESIDENCY_CARD_FOR_FOREIGNER
```
public static final DocumentType JP_RESIDENCY_CARD_FOR_FOREIGNER
```
    Japanese residence card for foreigners.
  - JP_INDIVIDUAL_NUMBER_CARD
```
public static final DocumentType JP_INDIVIDUAL_NUMBER_CARD
```
    Japanese national ID card.
  - JP_PERMANENT_RESIDENCY_CARD_FOR_FOREIGNER
```
public static final DocumentType JP_PERMANENT_RESIDENCY_CARD_FOR_FOREIGNER
```
    Japanese special residency card for foreigners to permit permanent residence.
  - JP_HEALTH_INSURANCE_CARD
```
public static final DocumentType JP_HEALTH_INSURANCE_CARD
```
    Japanese health insurance card.
  - JP_RESIDENCY_CARD
```
public static final DocumentType JP_RESIDENCY_CARD
```
    Japanese residency card.
  - BANK_STATEMENT
```
public static final DocumentType BANK_STATEMENT
```
    Bank statement from a recognised banking institution.
  - UTILITY_STATEMENT
```
public static final DocumentType UTILITY_STATEMENT
```
    Statement from a recognised utility provider.
  - MORTGAGE_STATEMENT
```
public static final DocumentType MORTGAGE_STATEMENT
```
    Statement from a recognised mortgage provider.
  - LOAN_STATEMENT
```
public static final DocumentType LOAN_STATEMENT
```
    Statement from a recognised loan provider.
  - TAX_STATEMENT
```
public static final DocumentType TAX_STATEMENT
```
    Statement from a country's tax authority.
  - SOCIAL_SECURITY_STATEMENT
```
public static final DocumentType SOCIAL_SECURITY_STATEMENT
```
    Statement from a country's social security authority.
  - PILOT_PERMIT
```
public static final DocumentType PILOT_PERMIT
```
    Official document permitting an individual to operate an aircraft.
  - BIRTH_CERTIFICATE
```
public static final DocumentType BIRTH_CERTIFICATE
```
    Official document certifying the circumstances of a birth.
  - ADOPTION_CERTIFICATE
```
public static final DocumentType ADOPTION_CERTIFICATE
```
    Official document certifying the circumstances of an adoption.
  - MARRIAGE_CERTIFICATE
```
public static final DocumentType MARRIAGE_CERTIFICATE
```
    Official document certifying the circumstances of a marriage.
  - GENDER_CERTIFICATE
```
public static final DocumentType GENDER_CERTIFICATE
```
    Official document certifying that a person has satisfied the criteria for legal recognition in the acquired gender.
  - FIREARM_PERMIT
```
public static final DocumentType FIREARM_PERMIT
```
    Official document permitting an individual to use or own a firearm.
  - EDUCATION_CERTIFICATE
```
public static final DocumentType EDUCATION_CERTIFICATE
```
    Document certifying that a person has received specific education or has passed a test or series of tests.
  - VISA
```
public static final DocumentType VISA
```
    Document that grants the holder official permission to enter, leave or stay in a country.
  - MILITARY_ID
```
public static final DocumentType MILITARY_ID
```
    An official military identity document issued by a country's government to its service personnel.
  - VOTER_ID
```
public static final DocumentType VOTER_ID
```
    An official voter identity document.
- Constructor Detail
  - DocumentType
```
public DocumentType(String value)
```
    Creates a new identity document type.
    
    Parameters:
    
    value - The identity document type value. Must not be null.
- Method Detail
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Identifier

Class DocumentType

Field Summary

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

Constructor Summary

Method Summary

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

Methods inherited from class java.lang.Object

Field Detail

IDCARD

PASSPORT

DRIVING_PERMIT

RESIDENCE_PERMIT

DE_IDCARD_FOREIGNERS

DE_EMERGENCY_IDCARD

DE_ERP

DE_ERP_REPLACEMENT_IDCARD

DE_IDCARD_REFUGEES

DE_IDCARD_APATRIDS

DE_CERTIFICATE_OF_SUSPENSION_OF_DEPORTATION

DE_PERMISSION_TO_RESIDE

DE_REPLACEMENT_IDCARD

JP_DRIVERS_LICENSE

JP_RESIDENCY_CARD_FOR_FOREIGNER

JP_INDIVIDUAL_NUMBER_CARD

JP_PERMANENT_RESIDENCY_CARD_FOR_FOREIGNER

JP_HEALTH_INSURANCE_CARD

JP_RESIDENCY_CARD

BANK_STATEMENT

UTILITY_STATEMENT

MORTGAGE_STATEMENT

LOAN_STATEMENT

TAX_STATEMENT

SOCIAL_SECURITY_STATEMENT

PILOT_PERMIT

BIRTH_CERTIFICATE

ADOPTION_CERTIFICATE

MARRIAGE_CERTIFICATE

GENDER_CERTIFICATE

FIREARM_PERMIT

EDUCATION_CERTIFICATE

VISA

MILITARY_ID

VOTER_ID

Constructor Detail

DocumentType

Method Detail

equals