@silexpert/core 2.0.44 → 2.0.45

package/dist/types/Interface/api/kyc/Read.d.ts

@@ -0,0 +1,830 @@
+export interface LegalRepresentative {
+    type: 'INDIVIDU' | 'ENTREPRISE';
+    siren?: string;
+    firstNames?: string;
+    lastName?: string;
+    roleEntreprise?: string;
+}
+export interface OAuthCredentials {
+    access_token: string;
+    expires_in: number;
+    scope: string;
+    jti: string;
+    sub: string;
+    token_type: string;
+    api_key_info: {
+        email: string;
+        id: string;
+        application_name: string;
+    };
+}
+export interface ReadKycPerson {
+    firsName: string;
+    lastName: string;
+    usageName: string;
+    gender: string;
+    nationality: string;
+    email: string;
+    phone: string;
+    birthData: {
+        date: string;
+        place: string;
+        department: string;
+    };
+    address: {
+        number: string;
+        street: string;
+        zipCode: string;
+        city: string;
+        province: string;
+        country: string;
+    };
+    company: string;
+    locale: string;
+    createdAt: string;
+    updatedAt: string;
+    _links: {
+        curies: PersonCurry[];
+        self: PersonLink;
+        'vl:space': PersonLink;
+        'vl:person-referers': PersonnLinkReferers;
+        'vl:legal-entity': PersonLink;
+        'vl:copied-from': PersonLink;
+        'lastest-version': PersonLink;
+        'version-history': PersonLink[];
+    };
+    _embedded: any;
+}
+export type PersonLink = {
+    href: string;
+};
+export type PersonnLinkReferers = PersonLink & {
+    templated: true;
+};
+export type PersonCurry = PersonLink & {
+    name: string;
+    templated: boolean;
+};
+export interface ReadKycFolder {
+    title: string;
+    status: 'DRAFT' | 'IN_PROGRESS' | 'COMPLETED' | 'REJECTED' | 'ACTION_NEEDED' | 'CANCELLED' | 'EXPIRED';
+    expiresOn: string;
+    metadata: {
+        key: string;
+        value: string;
+    }[];
+    createdAt: string;
+    updatedAt: string;
+    notificationDelay: any;
+    _links: {
+        curies: FolderLink[];
+        self: FolderLink;
+        'vl:space': FolderLink;
+        'vl-steps': FolderLink;
+        'vl-participants': FolderLink;
+        'vl-notifications': FolderLink;
+    };
+    _embedded: any;
+}
+export type FolderLink = {
+    href: string;
+    templated: boolean;
+    type?: string;
+    depreciation?: string;
+    name: string;
+    profile?: string;
+    tilte?: string;
+    hreflang?: string;
+};
+export interface PostFolderResponse {
+    _links: {
+        'vl:folder': {
+            href: string;
+            templated: boolean;
+            type: string;
+            deprecation: string;
+            name: string;
+            profile: string;
+            tilte: string;
+            hreflang: string;
+        };
+    };
+}
+export interface ReadKycFolderParticipants {
+    _embedded: {
+        'vl:participant': {
+            createdAt: string;
+            updatedAt: string;
+            token: string;
+            delegable: boolean;
+            _links: {
+                self: {
+                    href: string;
+                };
+                'vl:folder': {
+                    href: string;
+                };
+                'vl:step': [
+                    {
+                        href: string;
+                    },
+                    {
+                        href: string;
+                    },
+                    {
+                        href: string;
+                    },
+                    {
+                        href: string;
+                    }
+                ];
+                'vl:steps': {
+                    href: string;
+                };
+                'vl:challenge-builder': {
+                    href: string;
+                };
+                'vl:redirection': {
+                    href: string;
+                };
+                'vl:challenge': {
+                    href: string;
+                };
+                'vl:pool': {
+                    href: string;
+                };
+                'vl:contact': {
+                    href: string;
+                };
+                'vl:public': {
+                    href: string;
+                };
+            };
+            _embedded: {
+                'vl:step': {
+                    type: string;
+                    status: string;
+                    minScore: number;
+                    createdAt: string;
+                    updatedAt: string;
+                    comment: string | null;
+                    _links: {
+                        'vl:control': {
+                            href: string;
+                        };
+                        self: {
+                            href: string;
+                        };
+                        'vl:folder': {
+                            href: string;
+                        };
+                        'vl:participant': {
+                            href: string;
+                        };
+                        'vl:notifications': {
+                            href: string;
+                        };
+                        'vl:contact': {
+                            href: string;
+                        };
+                        'vl:public': {
+                            href: string;
+                        };
+                        'vl:capture'?: {
+                            href: string;
+                        };
+                        prev?: {
+                            href: string;
+                        };
+                        'vl:form'?: {
+                            href: string;
+                        };
+                        'vl:file'?: {
+                            href: string;
+                        } | {
+                            href: string;
+                        }[];
+                        'vl:form-editor'?: {
+                            href: string;
+                        };
+                        'vl:envelope'?: {
+                            href: string;
+                        };
+                    };
+                    _embedded: {
+                        'vl:rule': {
+                            rules: {
+                                compliant: boolean;
+                                complete: boolean;
+                                type: string;
+                                number: number;
+                                customType: string | null;
+                                withControl: boolean;
+                                operation: string;
+                            }[];
+                            compliant: boolean;
+                            complete: boolean;
+                            operation: string;
+                            _embedded: {
+                                'vl:rule': {
+                                    compliant: boolean;
+                                    complete: boolean;
+                                    operation: string;
+                                    withControl: boolean;
+                                    number: number;
+                                    type: string;
+                                    _links?: {
+                                        'vl:file': {
+                                            href: string;
+                                        };
+                                    };
+                                    _embedded: {
+                                        'vl:document': {
+                                            type: string;
+                                            subType: string;
+                                            number: number;
+                                            status: string;
+                                            origin: string;
+                                            score: number;
+                                            createdAt: string;
+                                            documentValues: string | null;
+                                            _links: {
+                                                self: {
+                                                    href: string;
+                                                };
+                                            };
+                                            _embedded: {
+                                                'vl:check-result': {
+                                                    name: string;
+                                                    value: string;
+                                                }[];
+                                                'vl:sheet': {
+                                                    side: string;
+                                                    fileName: string;
+                                                    subTypes: [string];
+                                                    identifier: string;
+                                                    _links: {
+                                                        self: {
+                                                            href: string;
+                                                        };
+                                                    };
+                                                }[];
+                                            };
+                                        };
+                                        'vl:file': {
+                                            contentType: string;
+                                            contentLength: number | null;
+                                            expiresOn: string | null;
+                                            createdAt: string;
+                                            updatedAt: string;
+                                            fileName: string;
+                                            metadata: {
+                                                key: string;
+                                                value: string;
+                                            }[];
+                                            classificationMethod: string;
+                                            type: string;
+                                            subType: string;
+                                            language: string;
+                                            trusted: boolean;
+                                            _links: {
+                                                'vl:space': {
+                                                    href: string;
+                                                };
+                                                'vl:bucket': {
+                                                    href: string;
+                                                };
+                                                'vl:file-referers': {
+                                                    href: string;
+                                                    templated: boolean;
+                                                };
+                                                'version-history': {
+                                                    href: string;
+                                                };
+                                                'latest-version': {
+                                                    href: string;
+                                                };
+                                                previous: {
+                                                    href: string;
+                                                };
+                                                self: {
+                                                    href: string;
+                                                };
+                                                'vl:file-content': {
+                                                    href: string;
+                                                    type: string;
+                                                };
+                                                'vl:curies': {
+                                                    href: string;
+                                                    name: string;
+                                                    templated: boolean;
+                                                };
+                                            };
+                                        };
+                                    };
+                                }[];
+                            };
+                        };
+                        'vl:smart-upload': {
+                            enabled: boolean;
+                            bundleCutting: boolean;
+                        };
+                    };
+                }[];
+                'vl:contact': {
+                    createdAt: string;
+                    updatedAt: string;
+                    locale: string;
+                    firstName: string;
+                    lastName: string;
+                    usageName: string | null;
+                    gender: string | null;
+                    nationality: string | null;
+                    email: string | null;
+                    phone: string | null;
+                    birthData: string | null;
+                    address: string | null;
+                    _links: {
+                        'vl:space': {
+                            href: string;
+                        };
+                        'vl:person-referers': {
+                            href: string;
+                            templated: boolean;
+                        };
+                        'version-history': {
+                            href: string;
+                        };
+                        'latest-version': {
+                            href: string;
+                        };
+                        self: {
+                            href: string;
+                        };
+                        'vl:curies': {
+                            href: string;
+                            name: string;
+                            templated: boolean;
+                        };
+                    };
+                };
+            };
+        }[];
+    };
+    _links: {
+        self: {
+            href: string;
+        };
+        curies: {
+            name: string;
+            href: string;
+            templated: boolean;
+        }[];
+    };
+}
+export interface ReadKycFolderSteps {
+    _embedded: {
+        'vl:step': {
+            type: string;
+            status: string;
+            minScore: number;
+            createdAt: string;
+            updatedAt: string;
+            comment: string | null;
+            _links: {
+                'vl:control': {
+                    href: string;
+                };
+                self: {
+                    href: string;
+                };
+                'vl:folder': {
+                    href: string;
+                };
+                'vl:participant': {
+                    href: string;
+                };
+                'vl:notifications': {
+                    href: string;
+                };
+                'vl:contact': {
+                    href: string;
+                };
+                'vl:public': {
+                    href: string;
+                };
+                'vl:capture'?: {
+                    href: string;
+                };
+                prev?: {
+                    href: string;
+                };
+                'vl:form'?: {
+                    href: string;
+                };
+                'vl:file'?: {
+                    href: string;
+                } | {
+                    href: string;
+                }[];
+                'vl:form-editor'?: {
+                    href: string;
+                };
+                'vl:envelope'?: {
+                    href: string;
+                };
+            };
+            _embedded: {
+                'vl:rule': {
+                    rules: {
+                        compliant: boolean;
+                        complete: boolean;
+                        type: string;
+                        number: number;
+                        customType: string | null;
+                        withControl: boolean;
+                        operation: string;
+                    }[];
+                    compliant: boolean;
+                    complete: boolean;
+                    operation: string;
+                    _embedded: {
+                        'vl:rule': {
+                            compliant: boolean;
+                            complete: boolean;
+                            operation: string;
+                            withControl: boolean;
+                            number: number;
+                            type: string;
+                            _links?: {
+                                'vl:file': {
+                                    href: string;
+                                };
+                            };
+                            _embedded: {
+                                'vl:document': {
+                                    type: string;
+                                    subType: string;
+                                    number: number;
+                                    status: string;
+                                    origin: string;
+                                    score: number;
+                                    createdAt: string;
+                                    documentValues: string | null;
+                                    _links: {
+                                        self: {
+                                            href: string;
+                                        };
+                                    };
+                                    _embedded: {
+                                        'vl:check-result': {
+                                            name: string;
+                                            value: string;
+                                        }[];
+                                        'vl:sheet': {
+                                            side: string;
+                                            fileName: string;
+                                            subTypes: [string];
+                                            identifier: string;
+                                            _links: {
+                                                self: {
+                                                    href: string;
+                                                };
+                                            };
+                                        }[];
+                                    };
+                                };
+                                'vl:file': {
+                                    contentType: string;
+                                    contentLength: number | null;
+                                    expiresOn: string | null;
+                                    createdAt: string;
+                                    updatedAt: string;
+                                    fileName: string;
+                                    metadata: {
+                                        key: string;
+                                        value: string;
+                                    }[];
+                                    classificationMethod: string;
+                                    type: string;
+                                    subType: string;
+                                    language: string;
+                                    trusted: boolean;
+                                    _links: {
+                                        'vl:space': {
+                                            href: string;
+                                        };
+                                        'vl:bucket': {
+                                            href: string;
+                                        };
+                                        'vl:file-referers': {
+                                            href: string;
+                                            templated: boolean;
+                                        };
+                                        'version-history': {
+                                            href: string;
+                                        };
+                                        'latest-version': {
+                                            href: string;
+                                        };
+                                        previous: {
+                                            href: string;
+                                        };
+                                        self: {
+                                            href: string;
+                                        };
+                                        'vl:file-content': {
+                                            href: string;
+                                            type: string;
+                                        };
+                                        'vl:curies': {
+                                            href: string;
+                                            name: string;
+                                            templated: boolean;
+                                        };
+                                    };
+                                };
+                            };
+                        }[];
+                    };
+                };
+                'vl:smart-upload': {
+                    enabled: boolean;
+                    bundleCutting: boolean;
+                };
+            };
+        }[];
+    };
+    _links: {
+        curies: FolderLink[];
+        self: FolderLink;
+    };
+}
+export interface ReadTemplate {
+    fileName: string;
+    type?: string;
+    subType?: string;
+    language?: string;
+    classificationMethod?: string;
+    trusted?: boolean;
+    locked?: boolean;
+    metadata?: {
+        key: string;
+        value: string;
+    }[];
+    contentType: string;
+    expiresOn?: string;
+    createdAt: string;
+    updatedAt: string;
+    scanResult: string;
+    _links: {
+        curries?: FolderLink[];
+        self: FolderLink;
+        'vl:space': FolderLink;
+        'vl:bucket': FolderLink;
+        'vl:file-content': FolderLink;
+        'vl:file-referers': FolderLink;
+        'vl:copied-from'?: FolderLink;
+        'vl:thumbnail'?: FolderLink;
+        'vl:watermark'?: FolderLink;
+        about?: FolderLink;
+        collection?: FolderLink;
+        item?: FolderLink;
+        preview?: FolderLink;
+        next?: FolderLink;
+        previous?: FolderLink;
+        'latest-version': FolderLink;
+        'version-history': FolderLink;
+    };
+    _embedded: any;
+}
+export interface ReadKycFormBuilder {
+    _embedded?: any;
+    _links: {
+        curies?: FolderLink[];
+        self: FolderLink;
+        'vl:space': FolderLink;
+        'vl:file': FolderLink;
+        'vl:editors'?: FolderLink;
+        'vl:fields'?: FolderLink;
+        'vl:referers'?: FolderLink;
+    };
+}
+export interface ReadKycEnvelope {
+    status?: string;
+    signedAt?: string;
+    tosAcceptedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    _embedded?: any;
+    _links: {
+        curies?: FolderLink[];
+        'vl:space': FolderLink;
+        'vl:envelope-documents': FolderLink;
+        'vl:envelope-proof'?: FolderLink;
+        'vl:envelope-signer': FolderLink;
+    };
+}
+export interface ReadKycControl {
+    id?: string;
+    spaceId: string;
+    spaceName?: string;
+    status: string;
+    controlProfileId: string;
+    controlProfileName?: string;
+    subscriberId?: string;
+    subscriber?: KycSubscriber;
+    createdAt?: string;
+    lastModified?: string;
+    completeness?: KycCntrolCompleteness[];
+    score?: number;
+    result?: KycControlResult;
+}
+export type KycSubscriber = {
+    id?: string;
+    spaceId?: string;
+    type: string;
+    address?: {
+        address?: string;
+        city?: string;
+        province?: string;
+        zipCode?: string;
+        countryIso?: string;
+    };
+    complementaryData: {
+        origin: string;
+        type: string;
+        key: string;
+        data?: string;
+        jsonableType?: string;
+        pageNumber?: number;
+    };
+    additionalData?: any[];
+    contact?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    usageName?: string;
+    nationalityIso?: string;
+    gender?: string;
+    birthday?: string;
+    placeOfBirth?: string;
+    departmentOfBirth?: string;
+    phoneNumber?: string;
+    siren?: string;
+    legalName?: string;
+    legalForm?: string;
+    registrationDate?: string;
+};
+export type KycCntrolCompleteness = {
+    type: string;
+    number: number;
+    side: string;
+    available: boolean;
+    status?: string;
+};
+export type KycControlResult = {
+    status?: string;
+    score: number;
+    checkResults: KycControlResultCheckResults[];
+    nbPerformedChecks: number;
+    nbConfiguredChecks: number;
+    scores: KycControlResultScores;
+    scoresPerDocument: KycControlResultScores;
+};
+export type KycControlResultCheckResults = {
+    id?: number;
+    type: string;
+    name: string;
+    value: string;
+    weight: number;
+    critical: boolean;
+    sources: {
+        type: string;
+        documentId?: number;
+        documentType?: string;
+        number: number;
+        value: string;
+        label: string;
+    }[];
+    paramters?: {
+        name: string;
+        value: string;
+    }[];
+    public: boolean;
+};
+export type KycControlResultScores = {
+    [key: string]: number;
+};
+export interface ReadKycCaptureControl {
+    verificationType?: string;
+    providerName?: string;
+    _embedded: {
+        'vl:identity'?: {
+            firstName: string;
+            lastName: string;
+            birthDate: string;
+            _links: {
+                curies?: FolderLink[];
+                self: FolderLink;
+                'vl:capture': FolderLink;
+            };
+            _embedded: any;
+        };
+        'vl:capture-proof'?: {
+            _links: {
+                curies?: FolderLink[];
+                self: FolderLink;
+                'vl:capture': FolderLink;
+                'vl:file': FolderLink;
+            };
+            _embedded: any;
+        };
+        'vl:last-attempt': {
+            providerName: string;
+            outcome: string;
+            overallResult?: string;
+            faceMatching?: string;
+            liveness?: string;
+            attemptedAt?: string;
+            remainingAttempts: number;
+            _links: {
+                curies?: FolderLink[];
+                self: FolderLink;
+                'vl:capture': FolderLink;
+            };
+            _embedded: any;
+        };
+        'vl:gdpr-content': {
+            timestamp: string;
+            status: string;
+            comment?: string;
+            _links: {
+                curies?: FolderLink[];
+                self: FolderLink;
+                'vl:capture': FolderLink;
+            };
+            _embedded: any;
+        };
+        'vl:available-providers': {
+            providers: string;
+            _links: {
+                curies?: FolderLink[];
+                self: FolderLink;
+                'vl:capture': FolderLink;
+            };
+            _embedded: any;
+        };
+    };
+    verificationLevel: string;
+    maxAttempts: number;
+    createdAt: string;
+    updatedAt: string;
+    _links: {
+        curies?: FolderLink[];
+        self: FolderLink;
+        'vl:space': FolderLink;
+        'vl:contact': FolderLink;
+        'vl:capture-image'?: FolderLink;
+        'vl:capture-proof'?: FolderLink;
+        'vl:last-attempt'?: FolderLink;
+        'vl:gdpr-content'?: FolderLink;
+    };
+}
+export interface ReadKycCaptureProof {
+    _links: {
+        self: {
+            href: string;
+        };
+        'vl:capture': {
+            href: string;
+        };
+        'vl:file': {
+            href: string;
+        };
+        curries: {
+            name: string;
+            href: string;
+            templated: boolean;
+        }[];
+    };
+}
+export interface ReadKycSignatureProof {
+    _links: {
+        self: {
+            href: string;
+        };
+        'vl:envelope': {
+            href: string;
+        };
+        'vl:file': {
+            href: string;
+        };
+        curries: {
+            name: string;
+            href: string;
+            templated: boolean;
+        }[];
+    };
+}
+//# sourceMappingURL=Read.d.ts.map