getApplicant

This query loads the applicant's information.

General Pattern

query{
    getApplicant(organizationID: "UUID"){
    field_1
    field_2 {
       nested_field_1
       ...
    }
  }
}

Sample Query

query{
  getApplicant(organizationID:"a1dc174d-abf4-47d3-be3c-9281c6eba456"){
    id
    firstName
    lastName
    email
    dob
    idNumbers{
      type
      value
      stateCode
    }
    address{
      flatNumber
      buildingNumber
      buildingName
      street
      subStreet
      town
      postcode
      country
      line1
      state
    }
    href
  }
}

Argument

Name

Type

Description

Required

organizationID

UUID

The organization ID.

Yes

Fields

Name

Type

Description

ApplicantResponse

Object

An object that contains the ApplicantResponse object information, such as id, first name, last name, address, etc.