identity_documents

Creates, updates, deletes, gets or lists an identity_documents resource.

Overview

Name	identity_documents
Type	Resource
Id	godaddy.domains.identity_documents

Fields

The following fields are returned by SELECT queries:

list_identity_documents

Request was successful

Name	Datatype	Description
contact	object
identificationCountry	string (iso-country-code)	Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more
identificationNumber	string	Individual or business identification number written on the document. Must match image exactly
identificationType	string	Type of the identity document
identityDocumentId	string	The unique identifier of an identity document
legalEntityName	string	Individual or business name written on the document. Must match image exactly

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_identity_documents	select		X-Shopper-Id	Get a collection of identity documents the current shopper owns
create_identity_document	insert	data__contact, data__identificationCountry, data__identificationNumber, data__identificationType, data__image, data__legalEntityName	X-Shopper-Id	Create an Identity Document from uploaded image

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
X-Shopper-Id	string	Shopper ID of the owner of the identity document. This is only required if you are a Reseller managing identity documents for your customers. Use this header to pass in their subaccount ID

SELECT examples

list_identity_documents

Get a collection of identity documents the current shopper owns

SELECT
contact,
identificationCountry,
identificationNumber,
identificationType,
identityDocumentId,
legalEntityName
FROM godaddy.domains.identity_documents
WHERE X-Shopper-Id = '{{ X-Shopper-Id }}'
;

INSERT examples

create_identity_document

Create an Identity Document from uploaded image

INSERT INTO godaddy.domains.identity_documents (
data__contact,
data__identificationCountry,
data__identificationNumber,
data__identificationType,
data__image,
data__legalEntityName,
X-Shopper-Id
)
SELECT 
'{{ contact }}' /* required */,
'{{ identificationCountry }}' /* required */,
'{{ identificationNumber }}' /* required */,
'{{ identificationType }}' /* required */,
'{{ image }}' /* required */,
'{{ legalEntityName }}' /* required */,
'{{ X-Shopper-Id }}'
RETURNING
identityDocumentId
;

Manifest

# Description fields are for documentation purposes
- name: identity_documents
  props:
    - name: contact
      value: object
    - name: identificationCountry
      value: string
      description: |
        Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many  more
      valid_values: ['AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW']
    - name: identificationNumber
      value: string
      description: |
        Individual or business identification number written on the document. Must match image exactly
    - name: identificationType
      value: string
      description: |
        Type of the identity document
      valid_values: ['BUSINESS_LICENSE', 'DRIVERS_LICENSE', 'ORGANIZATION_CODE_CERTIFICATE', 'PASSPORT', 'RESIDENT_ID', 'RESIDENT_ID_TEMPORARY']
    - name: image
      value: string
      description: |
        The base64 encoded string of the document image. The document image size must be between 4KB and 10MB. Supported formats are bmp, jpg/jpeg, jfif, png, gif, and tiff
    - name: legalEntityName
      value: string
      description: |
        Individual or business name written on the document. Must match image exactly
    - name: X-Shopper-Id
      value: string
      description: Shopper ID of the owner of the identity document. This is only required if you are a Reseller managing identity documents for your customers. Use this header to pass in their subaccount ID