identity_documents_verifications

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

Overview

Name	identity_documents_verifications
Type	Resource
Id	godaddy.domains.identity_documents_verifications

Fields

The following fields are returned by SELECT queries:

get_identity_document_verification

Request was successful

Name	Datatype	Description
createdAt	string (iso-datetime)	Timestamp indicating when the user created the identity document verification job
status	string
tld	string	Top level domain the current identity document verification is for

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_identity_document_verification	select	identity_document_id	X-Shopper-Id, tlds	Retrieve a list of Verifications for the specified Identity Document
create_verification	insert	identity_document_id, tlds	X-Shopper-Id	Only one verification job is needed for one TLD, Top Level Domain, per identity document. Sending in request(s) with multiple domains for the same TLD, will not create multiple verification jobs. We accept domain names for the convenience of our customers so that they don't need to worry about parsing TLDs out of domain names

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
identity_document_id	string	Unique id of an identity document
tlds	array	An array of TLDs for which the verification was started. Alternately you can specify the whole domain from which the TLD will be extracted
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
tlds	array	An array of TLDs for which to retrieve identity document verification jobs. Alternately you can specify the whole domain from which the TLD will be extracted

SELECT examples

get_identity_document_verification

Retrieve a list of Verifications for the specified Identity Document

SELECT
createdAt,
status,
tld
FROM godaddy.domains.identity_documents_verifications
WHERE identity_document_id = '{{ identity_document_id }}' -- required
AND X-Shopper-Id = '{{ X-Shopper-Id }}'
AND tlds = '{{ tlds }}'
;

INSERT examples

create_verification

Only one verification job is needed for one TLD, Top Level Domain, per identity document. Sending in request(s) with multiple domains for the same TLD, will not create multiple verification jobs. We accept domain names for the convenience of our customers so that they don't need to worry about parsing TLDs out of domain names

INSERT INTO godaddy.domains.identity_documents_verifications (
identity_document_id,
tlds,
X-Shopper-Id
)
SELECT 
'{{ identity_document_id }}',
'{{ tlds }}',
'{{ X-Shopper-Id }}'
RETURNING
createdAt,
status,
tld
;

Manifest

# Description fields are for documentation purposes
- name: identity_documents_verifications
  props:
    - name: identity_document_id
      value: string
      description: Required parameter for the identity_documents_verifications resource.
    - name: tlds
      value: array
      description: Required parameter for the identity_documents_verifications resource.
    - 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