java.lang.Object
- com.adyen.model.legalentitymanagement.IdentificationData

public class IdentificationData
extends Object

IdentificationData

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`IdentificationData.CustomTypeAdapterFactory`
`static class`	`IdentificationData.TypeEnum`	Type of document, used when providing an ID number or uploading a document.

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_CARD_NUMBER`
`static String`	`SERIALIZED_NAME_EXPIRY_DATE`
`static String`	`SERIALIZED_NAME_ISSUER_COUNTRY`
`static String`	`SERIALIZED_NAME_ISSUER_STATE`
`static String`	`SERIALIZED_NAME_NATIONAL_ID_EXEMPT`
`static String`	`SERIALIZED_NAME_NUMBER`
`static String`	`SERIALIZED_NAME_TYPE`

Constructor Summary

Constructors
Constructor Description

IdentificationData()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`IdentificationData`	`cardNumber(String cardNumber)`
`boolean`	`equals(Object o)`
`IdentificationData`	`expiryDate(String expiryDate)`
`static IdentificationData`	`fromJson(String jsonString)`	Create an instance of IdentificationData given an JSON string
`String`	`getCardNumber()`	The card number of the document that was issued (AU only).
`String`	`getExpiryDate()`	Deprecated.
`String`	`getIssuerCountry()`	Deprecated.
`String`	`getIssuerState()`	The state or province where the document was issued (AU only).
`Boolean`	`getNationalIdExempt()`	Applies only to individuals in the US.
`String`	`getNumber()`	The number in the document.
`IdentificationData.TypeEnum`	`getType()`	Type of document, used when providing an ID number or uploading a document.
`int`	`hashCode()`
`IdentificationData`	`issuerCountry(String issuerCountry)`
`IdentificationData`	`issuerState(String issuerState)`
`IdentificationData`	`nationalIdExempt(Boolean nationalIdExempt)`
`IdentificationData`	`number(String number)`
`void`	`setCardNumber(String cardNumber)`
`void`	`setExpiryDate(String expiryDate)`
`void`	`setIssuerCountry(String issuerCountry)`
`void`	`setIssuerState(String issuerState)`
`void`	`setNationalIdExempt(Boolean nationalIdExempt)`
`void`	`setNumber(String number)`
`void`	`setType(IdentificationData.TypeEnum type)`
`String`	`toJson()`	Convert an instance of IdentificationData to an JSON string
`String`	`toString()`
`IdentificationData`	`type(IdentificationData.TypeEnum type)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CARD_NUMBER
```
public static final String SERIALIZED_NAME_CARD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXPIRY_DATE
```
public static final String SERIALIZED_NAME_EXPIRY_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISSUER_COUNTRY
```
public static final String SERIALIZED_NAME_ISSUER_COUNTRY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISSUER_STATE
```
public static final String SERIALIZED_NAME_ISSUER_STATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NATIONAL_ID_EXEMPT
```
public static final String SERIALIZED_NAME_NATIONAL_ID_EXEMPT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NUMBER
```
public static final String SERIALIZED_NAME_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - IdentificationData
```
public IdentificationData()
```
- Method Detail
  - cardNumber
```
public IdentificationData cardNumber(String cardNumber)
```
  - getCardNumber
```
public String getCardNumber()
```
    The card number of the document that was issued (AU only).
    
    Returns:
    
    cardNumber
  - setCardNumber
```
public void setCardNumber(String cardNumber)
```
  - expiryDate
```
public IdentificationData expiryDate(String expiryDate)
```
  - getExpiryDate
```
@Deprecated
public String getExpiryDate()
```
    Deprecated.
    
    The expiry date of the document, in YYYY-MM-DD format.
    
    Returns:
    
    expiryDate
  - setExpiryDate
```
public void setExpiryDate(String expiryDate)
```
  - issuerCountry
```
public IdentificationData issuerCountry(String issuerCountry)
```
  - getIssuerCountry
```
@Deprecated
public String getIssuerCountry()
```
    Deprecated.
    
    The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**.
    
    Returns:
    
    issuerCountry
  - setIssuerCountry
```
public void setIssuerCountry(String issuerCountry)
```
  - issuerState
```
public IdentificationData issuerState(String issuerState)
```
  - getIssuerState
```
public String getIssuerState()
```
    The state or province where the document was issued (AU only).
    
    Returns:
    
    issuerState
  - setIssuerState
```
public void setIssuerState(String issuerState)
```
  - nationalIdExempt
```
public IdentificationData nationalIdExempt(Boolean nationalIdExempt)
```
  - getNationalIdExempt
```
public Boolean getNationalIdExempt()
```
    Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.
    
    Returns:
    
    nationalIdExempt
  - setNationalIdExempt
```
public void setNationalIdExempt(Boolean nationalIdExempt)
```
  - number
```
public IdentificationData number(String number)
```
  - getNumber
```
public String getNumber()
```
    The number in the document.
    
    Returns:
    
    number
  - setNumber
```
public void setNumber(String number)
```
  - type
```
public IdentificationData type(IdentificationData.TypeEnum type)
```
  - getType
```
public IdentificationData.TypeEnum getType()
```
    Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. When providing ID numbers: * For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**. When uploading photo IDs: * For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**. When uploading other documents: * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).
    
    Returns:
    
    type
  - setType
```
public void setType(IdentificationData.TypeEnum type)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to IdentificationData
  - fromJson
```
public static IdentificationData fromJson(String jsonString)
                                   throws IOException
```
    Create an instance of IdentificationData given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of IdentificationData
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to IdentificationData
  - toJson
```
public String toJson()
```
    Convert an instance of IdentificationData to an JSON string
    
    Returns:
    
    JSON string

Class IdentificationData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CARD_NUMBER

SERIALIZED_NAME_EXPIRY_DATE

SERIALIZED_NAME_ISSUER_COUNTRY

SERIALIZED_NAME_ISSUER_STATE

SERIALIZED_NAME_NATIONAL_ID_EXEMPT

SERIALIZED_NAME_NUMBER

SERIALIZED_NAME_TYPE

openapiFields

openapiRequiredFields

Constructor Detail

IdentificationData

Method Detail

cardNumber

getCardNumber

setCardNumber

expiryDate

getExpiryDate

setExpiryDate

issuerCountry

getIssuerCountry

setIssuerCountry

issuerState

getIssuerState

setIssuerState

nationalIdExempt

getNationalIdExempt

setNationalIdExempt

number

getNumber

setNumber

type

getType

setType

equals

hashCode

toString

validateJsonObject

fromJson

toJson