com.plivo.api.models.identity

Class Identity

java.lang.Object

com.plivo.api.models.base.BaseResource

com.plivo.api.models.identity.Identity

public class Identity
extends BaseResource

Field Summary

Fields inherited from class com.plivo.api.models.base.BaseResource

plivoClient

Constructor Summary

Constructors

Constructor and Description
Identity()

Method Summary

Modifier and Type	Method and Description
static IdentityCreator	creator(java.lang.String countryIso, java.lang.String salutation, java.lang.String firstName, java.lang.String lastName, java.lang.String birthPlace, java.time.LocalDate birthDate, java.lang.String nationality, java.lang.String idNationality, java.time.LocalDate idIssueDate, java.lang.String businessName, java.lang.String idType, java.lang.String idNumber, java.lang.String addressLine1, java.lang.String addressLine2, java.lang.String city, java.lang.String region, java.lang.String postalCode)
static IdentityDeleter	deleter(java.lang.String id)
java.lang.String	getAccount()
java.lang.String	getAddressLine1()
java.lang.String	getAddressLine2()
java.lang.String	getAlias()
java.lang.String	getBirthDate()
java.lang.String	getBirthPlace()
java.lang.String	getBusinessName()
java.lang.String	getCity()
java.lang.String	getCountryIso()
com.fasterxml.jackson.databind.JsonNode	getDocumentDetails()
java.lang.String	getFirstName()
java.lang.String	getFiscalIdentificationCode()
java.lang.String	getId()
java.lang.String	getIdIssueDate()
java.lang.String	getIdNationality()
java.lang.String	getIdNumber()
java.lang.String	getIdType()
java.lang.String	getLastName()
java.lang.String	getMunicipalCode()
java.lang.String	getNationality()
java.lang.String	getPostalCode()
java.lang.String	getRegion()
java.lang.String	getSalutation()
java.lang.String	getStreetCode()
java.lang.String	getSubaccount()
static IdentityGetter	getter(java.lang.String id)
java.lang.String	getUrl()
java.lang.String	getValidationStatus()
java.lang.String	getVerificationStatus()
static IdentityLister	lister()
static IdentityUpdater	updater(java.lang.String id)

Methods inherited from class com.plivo.api.models.base.BaseResource

getApiId, getPlivoClient, setPlivoClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Identity

public Identity()

Method Detail

creator

public static IdentityCreator creator(java.lang.String countryIso,
                                      java.lang.String salutation,
                                      java.lang.String firstName,
                                      java.lang.String lastName,
                                      java.lang.String birthPlace,
                                      java.time.LocalDate birthDate,
                                      java.lang.String nationality,
                                      java.lang.String idNationality,
                                      java.time.LocalDate idIssueDate,
                                      java.lang.String businessName,
                                      java.lang.String idType,
                                      java.lang.String idNumber,
                                      java.lang.String addressLine1,
                                      java.lang.String addressLine2,
                                      java.lang.String city,
                                      java.lang.String region,
                                      java.lang.String postalCode)

updater

public static IdentityUpdater updater(java.lang.String id)

deleter

public static IdentityDeleter deleter(java.lang.String id)

getter

public static IdentityGetter getter(java.lang.String id)

lister

public static IdentityLister lister()

getAccount

public java.lang.String getAccount()

Returns:

Account the address belongs to

getCountryIso

public java.lang.String getCountryIso()

Returns:

Country ISO 2 code.

getAlias

public java.lang.String getAlias()

Returns:

Alias name of the address.

getSalutation

public java.lang.String getSalutation()

getFirstName

public java.lang.String getFirstName()

Returns:

First name of the user for whom the identity is created.

getLastName

public java.lang.String getLastName()

Returns:

Last name of the user for whom the identity is created.

getBirthPlace

public java.lang.String getBirthPlace()

Returns:

Birthplace of the user for whom the identity is created.

getBirthDate

public java.lang.String getBirthDate()

Returns:

Birth date in yyyy-mm-dd format of the user for whom the identity is created.

getNationality

public java.lang.String getNationality()

Returns:

Nationality of the user for whom the identity is created.

getIdNationality

public java.lang.String getIdNationality()

Returns:

Nationality mentioned in the identity proof.

getIdIssueDate

public java.lang.String getIdIssueDate()

Returns:

Issue date in yyyy-mm-dd mentioned in the identity proof.

getBusinessName

public java.lang.String getBusinessName()

Returns:

Business name of the user for whom the identity is created.

getIdType

public java.lang.String getIdType()

Returns:

Building name/number

getIdNumber

public java.lang.String getIdNumber()

Returns:

The unique number on the identifier.

getAddressLine1

public java.lang.String getAddressLine1()

Returns:

Building name/number

getAddressLine2

public java.lang.String getAddressLine2()

Returns:

The street name/number of the address

getCity

public java.lang.String getCity()

Returns:

The city of the address for which the address proof is created

getRegion

public java.lang.String getRegion()

Returns:

The region of the address for which the address proof is created

getPostalCode

public java.lang.String getPostalCode()

Returns:

The postal code of the address that is being created

getFiscalIdentificationCode

public java.lang.String getFiscalIdentificationCode()

Returns:

The code is available for businesses alone and will be available for spain mobile numbers. If not present, return null

getStreetCode

public java.lang.String getStreetCode()

Returns:

Street code of the address. Return null if not present.

getMunicipalCode

public java.lang.String getMunicipalCode()

Returns:

Municipal code of the address. Return null if not present.

getValidationStatus

public java.lang.String getValidationStatus()

Returns:

Can take the following values: pending. accepted, rejected, null

getVerificationStatus

public java.lang.String getVerificationStatus()

Returns:

Can take the following values: pending. verified, rejected

getSubaccount

public java.lang.String getSubaccount()

Returns:

The link to the subaccount resource associated with the application. If the application belongs to the main account, this field will be null.

getUrl

public java.lang.String getUrl()

Returns:

A plivo wrapped link to the document stored in the Plivo CDN.

getDocumentDetails

public com.fasterxml.jackson.databind.JsonNode getDocumentDetails()

Returns:

The document details json object of the address.

getId

public java.lang.String getId()

Specified by:

getId in class BaseResource