REST API›Identity›Know Your Customer (KYC)

GET

Get KYC Identity

Get a KYC identity of a user.

Query Params

  • organizationId string

    at least 1 characters

  • enterpriseId string

    at least 1 characters

  • userId string

    at least 1 characters

  • identityId string

    at least 1 characters

  • allData boolean

Responses

200
OK

Response Body

object

  • identities array of objects required
    identities object
    • id string required
    • status string required
      The status of the KYC identity: initiating, awaiting document upload, input error, ssn error, taxid error, in review, incomplete verifications, awaiting signature, records uploaded, approved, declined

      at least 1 characters

    • organizationId string

      at least 1 characters

    • enterpriseId string

      at least 1 characters

    • userId string

      at least 1 characters

    • createdAt string date-time
    • updatedAt string date-time
    • errorDescription string

      at least 1 characters

    • occupation string
    • annualIncome string
    • netWorth string
    • sourceOfFunds string
    • sourceOfNetWorth string
    • countryOfCitizenship string
    • govIdCountryOfIssuance string
    • politicallyExposedPerson boolean
    • debugStatus string
    • country string
    • countryOfResidence string
    • addressCity string
    • addressPostalCode string
    • addressStreet1 string
    • addressStreet2 string
    • addressSubdivision string
    • birthDate string date-time
    • identificationNumber string
    • nameFirst string
    • nameLast string
    • nameMiddle string
    • phoneNumber string
    • selectedIdClass string
    • debugFailureReason string
    • emailAddress string
    • contractSignerNameFull string
    • contractSignedDate string date-time
    • contractSignedIPAddress string
    • contractVersion string
    • userAgreesToTerms string
    • signatureSubmitted string
    • signaturesSubmitted array of string enums
      csampamicwvraca
    • signaturesRequired array of string enums
      csampamicwvraca
400
Bad Request

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required
401
Unauthorized

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required
403
Forbidden

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required
404
Not Found

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required