getClientVerificationInfo

This API is used to retrieve the current status and detailed history of a client’s identity verification (KYC) process. It provides the front end with the specific sequence of actions required from the user, the status of each action, and any associated expiration dates for submitted documents or verified steps.

Documentation

Try it now

Request parameters:

The method works without parameters

Call example:
JavaScriptReact HookFlutter

getClientVerificationInfo()

Response examples:
SuccessError

{
  code: 0,
  rid: '0',
  data: {
    result: 0,
    result_text: null,
    details: {
      VerificationSteps: [{
        StepId: 8,
        Order: 1,
        IsOuterOfOrder: false,
        State: 4,
        Created: 1633680026,
        ExpireDate: 1633766426
      }, {
        StepId: 32,
        Order: 0,
        IsOuterOfOrder: true,
        State: 10,
        Created: 1633680026,
        PassDate: 1633680044,
        ExpireDate: 1634284826
      }]
    }
  }
}

Response parameters:

Name	Description	Type	Values

VerificationSteps	An array of objects, where each entry represents a single requirement or stage in the verification pipeline.	array	-
└─		object
└─ StepId	The unique numeric identifier for the type of verification step. EmailVerification = 1, PhoneVerification = 2, AddressVerification = 3, TsupisVerification = 4, SkypeVerification = 5, DepositVerification = 6, DocumentVerification = 7, EkengVerification = 8, Adult = 20, TermsAndConditions = 21, RisKManagementReview = 22, GBGDocumentVerification = 23, LegigameDocumentVerification = 24, PEPStatus = 25, SKKSClientVerification = 26, TruNarrativeVerification = 27, LegigameIdDocVerification = 28, LegigameAddressDocVerification = 29, LegigameBankDocVerification = 30, ItalyDataVerification = 31, BlackListVerification = 32, TruNarrativeAutoIdentification = 33, ProviderDocumentVerification = 34, KYCAIDVerification = 35, IDfyVerification = 36, SumSubVerification = 37, Identomat = 38, Zeev = 39, Signicat = 40, SignicatBrazil = 41, Legitimuz = 42, CustomDocVerification = 43, ColumbiaCompliance = 44, ExcludedPerson = 45, IdNowVerification = 46, YouVerify = 47	number	-
└─ Order	The sequential position of the step. Lower numbers generally indicate earlier stages in the process.	number	-
└─ IsOuterOfOrder	If true, the user can complete this specific step at any time, regardless of whether previous sequential steps are finished.	boolean	true / false
└─ State	A numeric code representing the current status of the step. Created = 0, Error = 3, Expired = 4, WaitingClient = 5, ClientResponded = 6, WaitingProvider = 7, ProviderResponded = 8, Verified = 10	number	-
└─ Created	The Unix timestamp indicating when this verification step was initially generated for the user.	number	-
└─ PassDate	The Unix timestamp indicating when the user successfully completed the step (omitted if not yet passed).	number	-
└─ ExpireDate	The Unix timestamp after which the step or the data provided for it becomes invalid and must be redone.	number	-