REST APIIdentityKnow Your Customer (KYC)

POST

Submit contract signatures for a given KYC identity.

Path Params

  • id string required

Body Params

array of objects

  • contractSignerNameFull string required
    The full name of the individual signing the contract

    at least 1 characters

  • contractSignedDate string date required
    The date the contract was signed (YYYY-MM-DD)
  • contractSignedIPAddress string required
    The IP address from which the contract was signed

    at least 1 characters

  • contractType string enum required
    The type of contract being signed
    csampamicwvraca
  • contractVersion string required
    The version of the contract being signed

    at least 1 characters

  • userAgreesToTerms boolean required
    Whether the user agrees to the terms and conditions

Responses

200
OK

Response Body

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 required

    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

  • 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