@complycube/api/dist/resources/Checks.d.ts

ComplyCube's Node.js library for the AML/KYC API

import { AxiosInstance } from "axios";
import { Resource } from "../Resource";
export type CheckRequest = {
    clientId?: string | null;
    type?: string | null;
    enableMonitoring?: boolean | null;
    addressId?: string | null;
    documentId?: string | null;
    livePhotoId?: string | null;
    liveVideoId?: string | null;
    options?: object | null;
    clientConsent?: boolean | null;
    lastActionBy?: string | null;
};
export type ValidateRequest = {
    outcome: string;
    comment?: string | null;
    matchId?: string | null;
};
export type Check = {
    id: string;
    clientId: string;
    entityName: string;
    type: string;
    enableMonitoring?: boolean | null;
    addressId?: string | null;
    documentId?: string | null;
    livePhotoId?: string | null;
    liveVideoId?: string | null;
    options?: object | null;
    clientConsent?: boolean | null;
    lastActionBy?: string | null;
    status: string;
    result?: string | null;
};
export declare class Checks extends Resource<CheckRequest> {
    constructor(axiosInstance: AxiosInstance);
    create(clientId: string, checkRequest: CheckRequest): Promise<Check>;
    get(id: string): Promise<Check>;
    update(id: string, checkRequest: CheckRequest): Promise<Check>;
    validate(id: string, validateRequest: ValidateRequest): Promise<ValidateRequest>;
    list(clientId: string, { page, pageSize }?: {
        page?: number;
        pageSize?: number;
    }): Promise<Check[]>;
}