CustomerDocument

Structure

Field	Type	Required	Description
id	Integer	true	Unique identifier for the CustomerDocument.
primary	Boolean	false	Sets if it is primary or not.
documentType	DocumentType	true	Gives more information about that document
number	String	true	Number identificative of the document
givenName	String	false
secondSurName	String	false
surName	String	true
genderType	GenderType	false	Type of gender.
birthDate	Date	false
birthCountryCode	String	false	Country where this customer was born. ISO 3166-1 alpha-2
birthPlace	String	false
effectiveDate	Date	false
expireDate	Date	false
street	String	false
city	String	false
stateProvName	String	false
stateProvCode	String	false	ISO 3166-2
countryCode	String	false	ISO 3166-1 alpha-2
postalCode	String	false
nationalityCountryCode	String	false	ISO 3166-1 alpha-2
countryOfIssuanceCode	String	false	ISO 3166-1 alpha-2
ocr	String	false
remark	String	false	Possible remarks about this document.

JSON representation

{
	"id": 131,
	"primary": true,
	"documentType": {
		"id": 5,
		"code": "5",
		"name": "National identity document"
	},
	"number": "DOC 1",
	"givenName": "John",
	"secondSurName": "J",
	"surName": "Jameson",
	"genderType": {
		"id": 1,
		"code": "M",
		"name": "Male"
	},
	"birthDate": "2000-01-01",
	"birthCountryCode": "ES",
	"birthPlace": "Washington",
	"effectiveDate": "2015-06-15",
	"expireDate": "2020-01-01",
	"street": null,
	"city": null,
	"stateProvName": "District of Columbia",
	"stateProvCode": "ES-B",
	"countryCode": "ES",
	"postalCode": "56944",
	"nationalityCountry": "ES",
	"countryOfIssuanceCode": "ES",
	"ocr": null,
	"remark": "Document Remark"
}

CustomerDocument

Structure

JSON representation

Related content