@cfxlabsinc/b2b-services
    Preparing search index...

    This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

    interface paths {
        "/": {
            delete?: undefined;
            get?: undefined;
            head: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": { content?: undefined; headers: { [name: string]: unknown } };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[] | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/accounts/{accountId}/balances": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { accountId: string };
                    query?: { currencyCode?: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: | {
                                    accountId: string;
                                    availableBalanceAmount?: number
                                    | null;
                                    availableBalanceInDefaultCcy?: number | null;
                                    balanceAmount?: number | null;
                                    balanceId: string;
                                    currencyCode: string;
                                    defaultCurrencyCode: string;
                                    negativeBalanceStartDate?: string | null;
                                    overdraftLimitAmount?: number | null;
                                    reservedAmount?: number | null;
                                    tenantCode?: string | null;
                                }[]
                                | null;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/accounts/{accountId}/balances-history": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { accountId: string };
                    query: { currencyCode?: string; validOn: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: | {
                                    accountId?: string
                                    | null;
                                    balanceHistoryId?: string | null;
                                    money?: { amount?: ...; currencyCode: ... };
                                    tenantCode?: string | null;
                                    validityRange?: { endDate?: ...; startDate?: ... };
                                }[]
                                | null;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/accounts/{accountId}/closure/start": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path: { accountId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            comment?: string
                            | null;
                            statusReasonCode?: "CUSTOMER_DECISION";
                        };
                        "application/json": {
                            comment?: string
                            | null;
                            statusReasonCode?: "CUSTOMER_DECISION";
                        };
                        "text/json": {
                            comment?: string
                            | null;
                            statusReasonCode?: "CUSTOMER_DECISION";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/accounts/{childAccountId}/parent-accounts": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { childAccountId: string };
                    query: { pageNumber: number; pageSize: number };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    total?: number | null;
                                    values?:
                                        | {
                                            accessRestricted?: ...;
                                            accountClassCode?: ...;
                                            accountId?: ...;
                                            accountName?: ...;
                                            accountNumbers?: ...;
                                            accountRelationshipId?: ...;
                                            accountTypeCode?: ...;
                                            accountTypeSetupCode?: ...;
                                            activationDate?: ...;
                                            bic?: ...;
                                            counterpartySectorCode?: ...;
                                            customerGroupCode?: ...;
                                            defaultCurrencyCode?: ...;
                                            iban?: ...;
                                            interestMethodAssignmentCode?: ...;
                                            intraOrgCode?: ...;
                                            jurisdictionCountryCode?: ...;
                                            personId?: ...;
                                            personName?: ...;
                                            personTypeCode?: ...;
                                            productCode?: ...;
                                            relationshipType?: ...;
                                            relationshipValidityRange?: ...;
                                            residencyCode?: ...;
                                            serviceProviderCode?: ...;
                                            source?: ...;
                                            statusCode?: ...;
                                            statusReasonCode?: ...;
                                            taxResidencyCountryCode?: ...;
                                            tenantCode?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/accounts/{parentAccountId}/child-accounts": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { parentAccountId: string };
                    query: { pageNumber: number; pageSize: number };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    total?: number | null;
                                    values?:
                                        | {
                                            accessRestricted?: ...;
                                            accountClassCode?: ...;
                                            accountId?: ...;
                                            accountName?: ...;
                                            accountNumbers?: ...;
                                            accountRelationshipId?: ...;
                                            accountTypeCode?: ...;
                                            accountTypeSetupCode?: ...;
                                            activationDate?: ...;
                                            bic?: ...;
                                            counterpartySectorCode?: ...;
                                            customerGroupCode?: ...;
                                            defaultCurrencyCode?: ...;
                                            iban?: ...;
                                            interestMethodAssignmentCode?: ...;
                                            intraOrgCode?: ...;
                                            jurisdictionCountryCode?: ...;
                                            personId?: ...;
                                            personName?: ...;
                                            personTypeCode?: ...;
                                            productCode?: ...;
                                            relationshipType?: ...;
                                            relationshipValidityRange?: ...;
                                            residencyCode?: ...;
                                            serviceProviderCode?: ...;
                                            source?: ...;
                                            statusCode?: ...;
                                            statusReasonCode?: ...;
                                            taxResidencyCountryCode?: ...;
                                            tenantCode?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/{personId}": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            birthDate?: string
                            | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customerTypeCode?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?: string | null;
                            email?: string | null;
                            givenName?: string | null;
                            home?: {
                                buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                                housingTypeCode?:
                                    | "PRIVATE"
                                    | "RENTED"
                                    | "PART_OWNERSHIP"
                                    | "LIVING_WITH_PARENTS"
                                    | "OTHER";
                            };
                            inactivationDate?: string
                            | null;
                            language?: string | null;
                            legalForm?: string | null;
                            liquidationDate?: string | null;
                            mainPersonId?: string | null;
                            maritalStatusCode?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: "M" | "F" | "O";
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCodeReason?: string
                            | null;
                            surname?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                            work?: {
                                activityCode?: string | null;
                                businessAreaCodes?: string[] | null;
                                employmentTimeCode?:
                                    | "TRIAL"
                                    | "UP_1_YEAR"
                                    | "UP_2_YEAR"
                                    | "UP_3_YEAR"
                                    | "UP_4_YEAR"
                                    | "MORE_4_YEAR";
                                fixedEmploymentLength?: number
                                | null;
                            };
                        };
                        "application/json": {
                            birthDate?: string
                            | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customerTypeCode?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?: string | null;
                            email?: string | null;
                            givenName?: string | null;
                            home?: {
                                buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                                housingTypeCode?:
                                    | "PRIVATE"
                                    | "RENTED"
                                    | "PART_OWNERSHIP"
                                    | "LIVING_WITH_PARENTS"
                                    | "OTHER";
                            };
                            inactivationDate?: string
                            | null;
                            language?: string | null;
                            legalForm?: string | null;
                            liquidationDate?: string | null;
                            mainPersonId?: string | null;
                            maritalStatusCode?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: "M" | "F" | "O";
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCodeReason?: string
                            | null;
                            surname?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                            work?: {
                                activityCode?: string | null;
                                businessAreaCodes?: string[] | null;
                                employmentTimeCode?:
                                    | "TRIAL"
                                    | "UP_1_YEAR"
                                    | "UP_2_YEAR"
                                    | "UP_3_YEAR"
                                    | "UP_4_YEAR"
                                    | "MORE_4_YEAR";
                                fixedEmploymentLength?: number
                                | null;
                            };
                        };
                        "text/json": {
                            birthDate?: string
                            | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customerTypeCode?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?: string | null;
                            email?: string | null;
                            givenName?: string | null;
                            home?: {
                                buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                                housingTypeCode?:
                                    | "PRIVATE"
                                    | "RENTED"
                                    | "PART_OWNERSHIP"
                                    | "LIVING_WITH_PARENTS"
                                    | "OTHER";
                            };
                            inactivationDate?: string
                            | null;
                            language?: string | null;
                            legalForm?: string | null;
                            liquidationDate?: string | null;
                            mainPersonId?: string | null;
                            maritalStatusCode?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: "M" | "F" | "O";
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCodeReason?: string
                            | null;
                            surname?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                            work?: {
                                activityCode?: string | null;
                                businessAreaCodes?: string[] | null;
                                employmentTimeCode?:
                                    | "TRIAL"
                                    | "UP_1_YEAR"
                                    | "UP_2_YEAR"
                                    | "UP_3_YEAR"
                                    | "UP_4_YEAR"
                                    | "MORE_4_YEAR";
                                fixedEmploymentLength?: number
                                | null;
                            };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    birthDate?: string | null;
                                    businessAreaCodes?: string[] | null;
                                    businessModelDescription?: string | null;
                                    counterpartySectorCode?: string | null;
                                    countryOfBirth?: string | null;
                                    creationDate?: string | null;
                                    customerTypeCode?: string | null;
                                    deathDate?: string | null;
                                    dependantPersons?: number | null;
                                    educationCode?: string | null;
                                    email?: string | null;
                                    forgotten?: boolean | null;
                                    fullName?: string | null;
                                    givenName?: string | null;
                                    home?: {
                                        buildingTypeCode?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                    };
                                    idCountryCode?: string
                                    | null;
                                    idNumber?: string | null;
                                    inactivationDate?: string | null;
                                    insertedDTime?: string | null;
                                    intraOrgCode?: string | null;
                                    language?: string | null;
                                    legalForm?: string | null;
                                    liquidationDate?: string | null;
                                    mainPersonId?: string | null;
                                    maritalStatusCode?: string | null;
                                    middleName?: string | null;
                                    name?: string | null;
                                    nationality?: string | null;
                                    pep?: boolean | null;
                                    pepExplanation?: string | null;
                                    personGroupCodes?: string[] | null;
                                    personId?: string | null;
                                    personTypeCode?: string | null;
                                    phoneCountryCode?: string | null;
                                    phoneNumber?: string | null;
                                    placeOfBirth?: string | null;
                                    registrationDate?: string | null;
                                    residencyCountryCode?: string | null;
                                    sex?: string | null;
                                    source?: {
                                        sourceLink?: (...) | (...) | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    statusCode?: string
                                    | null;
                                    statusCodeReason?: string | null;
                                    surname?: string | null;
                                    taxResidencyCountry?: string | null;
                                    tenantCode?: string | null;
                                    tradingName?: string | null;
                                    usResident?: boolean | null;
                                    webAddress?: string | null;
                                    work?: {
                                        activityCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/activate": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    additionalContacts?:
                                        | {
                                            additionalContactId?: ...;
                                            contactTypeCode?: ...;
                                            description?: ...;
                                            email?: ...;
                                            personId?: ...;
                                            phoneCountryCode?: ...;
                                            phoneNumber?: ...;
                                            preferredMethodOfContact?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    additionalInfo?: {
                                        birthDate?: (...)
                                        | (...)
                                        | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    addresses?: | {
                                        addressId?: ...;
                                        addressTypeCode?: ...;
                                        apartmentNumber?: ...;
                                        buildingName?: ...;
                                        buildingNumber?: ...;
                                        cityCounty?: ...;
                                        countryCode?: ...;
                                        department?: ...;
                                        district?: ...;
                                        floor?: ...;
                                        moveInDate?: ...;
                                        personId?: ...;
                                        postBox?: ...;
                                        stateRegion?: ...;
                                        street1?: ...;
                                        street2?: ...;
                                        streetName?: ...;
                                        structured?: ...;
                                        subDepartment?: ...;
                                        townLocationName?: ...;
                                        validityRange?: ...;
                                        zip?: ...;
                                    }[]
                                    | null;
                                    creationDate?: string
                                    | null;
                                    documents?:
                                        | {
                                            docuId?: ...;
                                            documentTypeCode?: ...;
                                            expiryDate?: ...;
                                            issuingCountry?: ...;
                                            number?: ...;
                                            personId?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    forgotten?: boolean
                                    | null;
                                    fullName?: string | null;
                                    home?: {
                                        buildingTypeCode?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                    };
                                    identificationNumbers?: | {
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        idNumberId?: ...;
                                        personId?: ...;
                                        primary?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    legalForm?: string
                                    | null;
                                    mainPersonId?: string | null;
                                    personalInfo?: {
                                        dependantPersons?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                    };
                                    personGroupCodes?: | {
                                        personGroupCode: ...;
                                        personGroupId?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    personId?: string
                                    | null;
                                    relationships?:
                                        | {
                                            additionalData?: ...;
                                            beneficiary?: ...;
                                            parent?: ...;
                                            parentPersonId?: ...;
                                            percentageOfShares?: ...;
                                            percentageOfSignature?: ...;
                                            person?: ...;
                                            personId?: ...;
                                            personRelationshipId?: ...;
                                            relationTypeCode?: ...;
                                            representingRange?: ...;
                                            role?: ...;
                                            statusCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    source?: {
                                        sourceLink?: (...)
                                        | (...)
                                        | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    statusCode?: string
                                    | null;
                                    taxNumbers?:
                                        | {
                                            personId?: ...;
                                            primary?: ...;
                                            taxCountryCode?: ...;
                                            taxNumber?: ...;
                                            taxNumberId?: ...;
                                            taxNumberTypeCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    tenantCode?: string
                                    | null;
                                    work?: {
                                        activityCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/additional": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            birthDate?: string
                            | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?:
                                | "PRIMARY"
                                | "SECONDARY"
                                | "VOCATIONAL_SCHOOL"
                                | "HIGHER_EDUCATION";
                            inactivationDate?: string
                            | null;
                            language?: string | null;
                            liquidationDate?: string | null;
                            maritalStatusCode?:
                                | "SINGLE"
                                | "MARRIED"
                                | "DIVORCED"
                                | "WIDOW"
                                | "COHABITANT";
                            pep?: boolean
                            | null;
                            pepExplanation?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            statusCodeReason?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                        "application/json": {
                            birthDate?: string
                            | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?:
                                | "PRIMARY"
                                | "SECONDARY"
                                | "VOCATIONAL_SCHOOL"
                                | "HIGHER_EDUCATION";
                            inactivationDate?: string
                            | null;
                            language?: string | null;
                            liquidationDate?: string | null;
                            maritalStatusCode?:
                                | "SINGLE"
                                | "MARRIED"
                                | "DIVORCED"
                                | "WIDOW"
                                | "COHABITANT";
                            pep?: boolean
                            | null;
                            pepExplanation?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            statusCodeReason?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                        "text/json": {
                            birthDate?: string
                            | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?:
                                | "PRIMARY"
                                | "SECONDARY"
                                | "VOCATIONAL_SCHOOL"
                                | "HIGHER_EDUCATION";
                            inactivationDate?: string
                            | null;
                            language?: string | null;
                            liquidationDate?: string | null;
                            maritalStatusCode?:
                                | "SINGLE"
                                | "MARRIED"
                                | "DIVORCED"
                                | "WIDOW"
                                | "COHABITANT";
                            pep?: boolean
                            | null;
                            pepExplanation?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            statusCodeReason?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    birthDate?: string
                                    | null;
                                    businessAreaCodes?: string[] | null;
                                    businessModelDescription?: string | null;
                                    counterpartySectorCode?: string | null;
                                    countryOfBirth?: string | null;
                                    customerTypeCode?: string | null;
                                    deathDate?: string | null;
                                    dependantPersons?: number | null;
                                    educationCode?: string | null;
                                    inactivationDate?: string | null;
                                    intraOrgCode?: string | null;
                                    language?: string | null;
                                    liquidationDate?: string | null;
                                    mainPersonId?: string | null;
                                    maritalStatusCode?: string | null;
                                    pep?: boolean | null;
                                    pepExplanation?: string | null;
                                    placeOfBirth?: string | null;
                                    registrationDate?: string | null;
                                    statusCodeReason?: string | null;
                                    taxResidencyCountry?: string | null;
                                    tradingName?: string | null;
                                    usResident?: boolean | null;
                                    webAddress?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/addresses": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    addressId?: string
                                    | null;
                                    addressTypeCode?: string | null;
                                    apartmentNumber?: string | null;
                                    buildingName?: string | null;
                                    buildingNumber?: string | null;
                                    cityCounty?: string | null;
                                    countryCode?: string | null;
                                    department?: string | null;
                                    district?: string | null;
                                    floor?: string | null;
                                    moveInDate?: string | null;
                                    personId?: string | null;
                                    postBox?: string | null;
                                    stateRegion?: string | null;
                                    street1?: string | null;
                                    street2?: string | null;
                                    streetName?: string | null;
                                    structured?: boolean | null;
                                    subDepartment?: string | null;
                                    townLocationName?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                    zip?: string
                                    | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/personal": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            email?: string
                            | null;
                            givenName?: string | null;
                            legalForm?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: "M" | "F" | "O";
                            surname?: string | null;
                        };
                        "application/json": {
                            email?: string
                            | null;
                            givenName?: string | null;
                            legalForm?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: "M" | "F" | "O";
                            surname?: string | null;
                        };
                        "text/json": {
                            email?: string
                            | null;
                            givenName?: string | null;
                            legalForm?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: "M" | "F" | "O";
                            surname?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    dependantPersons?: number
                                    | null;
                                    email?: string | null;
                                    givenName?: string | null;
                                    legalForm?: string | null;
                                    middleName?: string | null;
                                    name?: string | null;
                                    nationality?: string | null;
                                    personTypeCode?: string | null;
                                    phoneCountryCode?: string | null;
                                    phoneNumber?: string | null;
                                    residencyCountryCode?: string | null;
                                    sex?: string | null;
                                    surname?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/relations": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            relationships: {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean;
                                customFields?: { [key: string]: unknown } | null;
                                idCountryCode: string;
                                idNumber: string;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                relationTypeCode:
                                    | "REPRESENTATIVE"
                                    | "SHAREHOLDER"
                                    | "DIRECTOR"
                                    | "MEMBER_OF_BOARD"
                                    | "SUPERVISORY_BOARD_MEMBER"
                                    | "EXECUTIVE_OFFICER"
                                    | "ACCOUNTANT";
                                representingRange: {
                                    endDate?: string
                                    | null;
                                    startDate?: string | null;
                                };
                                role?: string
                                | null;
                                source?: { sourceName: string; sourceRef: string };
                                statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                            }[];
                        };
                        "application/json": {
                            relationships: {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean;
                                customFields?: { [key: string]: unknown } | null;
                                idCountryCode: string;
                                idNumber: string;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                relationTypeCode:
                                    | "REPRESENTATIVE"
                                    | "SHAREHOLDER"
                                    | "DIRECTOR"
                                    | "MEMBER_OF_BOARD"
                                    | "SUPERVISORY_BOARD_MEMBER"
                                    | "EXECUTIVE_OFFICER"
                                    | "ACCOUNTANT";
                                representingRange: {
                                    endDate?: string
                                    | null;
                                    startDate?: string | null;
                                };
                                role?: string
                                | null;
                                source?: { sourceName: string; sourceRef: string };
                                statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                            }[];
                        };
                        "text/json": {
                            relationships: {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean;
                                customFields?: { [key: string]: unknown } | null;
                                idCountryCode: string;
                                idNumber: string;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                relationTypeCode:
                                    | "REPRESENTATIVE"
                                    | "SHAREHOLDER"
                                    | "DIRECTOR"
                                    | "MEMBER_OF_BOARD"
                                    | "SUPERVISORY_BOARD_MEMBER"
                                    | "EXECUTIVE_OFFICER"
                                    | "ACCOUNTANT";
                                representingRange: {
                                    endDate?: string
                                    | null;
                                    startDate?: string | null;
                                };
                                role?: string
                                | null;
                                source?: { sourceName: string; sourceRef: string };
                                statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                            }[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: | {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean | null;
                                    parent?: {
                                        accessRestricted?: ...;
                                        activityCode?: ...;
                                        birthDate?: ...;
                                        buildingTypeCode?: ...;
                                        businessAreaCodes?: ...;
                                        businessModelDescription?: ...;
                                        counterpartySectorCode?: ...;
                                        countryOfBirth?: ...;
                                        creationDate?: ...;
                                        customerTypeCode?: ...;
                                        deathDate?: ...;
                                        dependantPersons?: ...;
                                        educationCode?: ...;
                                        email?: ...;
                                        employmentTimeCode?: ...;
                                        fixedEmploymentLength?: ...;
                                        forgotten?: ...;
                                        fullName?: ...;
                                        givenName?: ...;
                                        housingTypeCode?: ...;
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        inactivationDate?: ...;
                                        insertedDTime?: ...;
                                        intraOrgCode?: ...;
                                        language?: ...;
                                        legalForm?: ...;
                                        liquidationDate?: ...;
                                        mainPersonId?: ...;
                                        maritalStatusCode?: ...;
                                        middleName?: ...;
                                        name?: ...;
                                        nationality?: ...;
                                        pep?: ...;
                                        pepExplanation?: ...;
                                        personGroupCodes?: ...;
                                        personId?: ...;
                                        personTypeCode?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        placeOfBirth?: ...;
                                        registrationDate?: ...;
                                        residencyCountryCode?: ...;
                                        sex?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusCodeReason?: ...;
                                        surname?: ...;
                                        taxResidencyCountry?: ...;
                                        tenantCode?: ...;
                                        tradingName?: ...;
                                        usResident?: ...;
                                        webAddress?: ...;
                                    };
                                    parentPersonId?: string
                                    | null;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    person?: {
                                        accessRestricted?: ...;
                                        activityCode?: ...;
                                        birthDate?: ...;
                                        buildingTypeCode?: ...;
                                        businessAreaCodes?: ...;
                                        businessModelDescription?: ...;
                                        counterpartySectorCode?: ...;
                                        countryOfBirth?: ...;
                                        creationDate?: ...;
                                        customerTypeCode?: ...;
                                        deathDate?: ...;
                                        dependantPersons?: ...;
                                        educationCode?: ...;
                                        email?: ...;
                                        employmentTimeCode?: ...;
                                        fixedEmploymentLength?: ...;
                                        forgotten?: ...;
                                        fullName?: ...;
                                        givenName?: ...;
                                        housingTypeCode?: ...;
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        inactivationDate?: ...;
                                        insertedDTime?: ...;
                                        intraOrgCode?: ...;
                                        language?: ...;
                                        legalForm?: ...;
                                        liquidationDate?: ...;
                                        mainPersonId?: ...;
                                        maritalStatusCode?: ...;
                                        middleName?: ...;
                                        name?: ...;
                                        nationality?: ...;
                                        pep?: ...;
                                        pepExplanation?: ...;
                                        personGroupCodes?: ...;
                                        personId?: ...;
                                        personTypeCode?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        placeOfBirth?: ...;
                                        registrationDate?: ...;
                                        residencyCountryCode?: ...;
                                        sex?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusCodeReason?: ...;
                                        surname?: ...;
                                        taxResidencyCountry?: ...;
                                        tenantCode?: ...;
                                        tradingName?: ...;
                                        usResident?: ...;
                                        webAddress?: ...;
                                    };
                                    personId?: string
                                    | null;
                                    personRelationshipId?: string | null;
                                    relationTypeCode?: string | null;
                                    representingRange?: { endDate?: ...; startDate?: ... };
                                    role?: string | null;
                                    statusCode?: string | null;
                                    validityRange?: { endTime?: ...; startTime?: ... };
                                }[]
                                | null;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/relations/closing/{personRelationshipId}": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path: { personId: string; personRelationshipId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean | null;
                                    parent?: {
                                        accessRestricted?: (...) | (...) | (...) | (...);
                                        activityCode?: (...) | (...) | (...);
                                        birthDate?: (...) | (...) | (...);
                                        buildingTypeCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        creationDate?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                        forgotten?: (...) | (...) | (...) | (...);
                                        fullName?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                        idCountryCode?: (...) | (...) | (...);
                                        idNumber?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        insertedDTime?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        personGroupCodes?: (...) | (...) | (...);
                                        personId?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        source?: (...) | (...);
                                        statusCode?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tenantCode?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    parentPersonId?: string
                                    | null;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    person?: {
                                        accessRestricted?: (...) | (...) | (...) | (...);
                                        activityCode?: (...) | (...) | (...);
                                        birthDate?: (...) | (...) | (...);
                                        buildingTypeCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        creationDate?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                        forgotten?: (...) | (...) | (...) | (...);
                                        fullName?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                        idCountryCode?: (...) | (...) | (...);
                                        idNumber?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        insertedDTime?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        personGroupCodes?: (...) | (...) | (...);
                                        personId?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        source?: (...) | (...);
                                        statusCode?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tenantCode?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    personId?: string
                                    | null;
                                    personRelationshipId?: string | null;
                                    relationTypeCode?: string | null;
                                    representingRange?: {
                                        endDate?: (...) | (...) | (...);
                                        startDate?: (...) | (...) | (...);
                                    };
                                    role?: string
                                    | null;
                                    statusCode?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/{personId}/risks": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            date?: string
                            | null;
                            riskLevelCode: string;
                            riskTypeCode: string;
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            value?: number
                            | null;
                        };
                        "application/json": {
                            date?: string
                            | null;
                            riskLevelCode: string;
                            riskTypeCode: string;
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            value?: number
                            | null;
                        };
                        "text/json": {
                            date?: string
                            | null;
                            riskLevelCode: string;
                            riskTypeCode: string;
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            value?: number
                            | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/custom-fields/value": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query: { personId: string; sourceName: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: | {
                                    fieldId: string;
                                    fieldName: string;
                                    fieldSetName: string;
                                    fieldValue: string;
                                    lookupEntityName?: string
                                    | null;
                                    lookupTypeCode?: string | null;
                                    textValues?: (...)[] | null;
                                    valueType: string;
                                }[]
                                | null;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            fieldValues: { fieldId: string; fieldValue: string }[];
                            source: { sourceName: string; sourceRef: string };
                        };
                        "application/json": {
                            fieldValues: { fieldId: string; fieldValue: string }[];
                            source: { sourceName: string; sourceRef: string };
                        };
                        "text/json": {
                            fieldValues: { fieldId: string; fieldValue: string }[];
                            source: { sourceName: string; sourceRef: string };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/files": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            contractSource?: {
                                contractNumber?: string
                                | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            fileBytes: string;
                            fileName: string;
                            fileTypeCode: string;
                            parameters?: { code?: string | null; value?: string | null }[]
                            | null;
                            source: { sourceName: string; sourceRef: string };
                        };
                        "application/json": {
                            contractSource?: {
                                contractNumber?: string
                                | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            fileBytes: string;
                            fileName: string;
                            fileTypeCode: string;
                            parameters?: { code?: string | null; value?: string | null }[]
                            | null;
                            source: { sourceName: string; sourceRef: string };
                        };
                        "text/json": {
                            contractSource?: {
                                contractNumber?: string
                                | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            fileBytes: string;
                            fileName: string;
                            fileTypeCode: string;
                            parameters?: { code?: string | null; value?: string | null }[]
                            | null;
                            source: { sourceName: string; sourceRef: string };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    addedDate?: string
                                    | null;
                                    contractSource?: {
                                        contractNumber?: (...) | (...) | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    deleted?: boolean
                                    | null;
                                    fileId?: string | null;
                                    fileName?: string | null;
                                    fileTypeCode?: string | null;
                                    parameters?: { code?: ...; value?: ... }[] | null;
                                    source?: { sourceName: string; sourceRef: string };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v1/persons/search": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query: {
                        addressTypeCode?:
                            | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                        birthDate?: string;
                        country?: string;
                        creationDateFrom?: string;
                        creationDateTo?: string;
                        firstName?: string;
                        globalSearch?: string;
                        idNumber?: string;
                        lastName?: string;
                        name?: string;
                        pageNumber: number;
                        pageSize: number;
                        personId?: string;
                        personIds?: string[];
                        personTypeCode?: "P"
                        | "L";
                        registrationDate?: string;
                        residencyCountryCode?: string;
                        sort?: { field?: string | null; order?: string | null }[];
                        statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                        statusCodeReason?: string;
                        statusCodes?: string[];
                        zip?: string;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    values?:
                                        | {
                                            accessRestricted?: ...;
                                            activityCode?: ...;
                                            birthDate?: ...;
                                            buildingTypeCode?: ...;
                                            businessAreaCodes?: ...;
                                            businessModelDescription?: ...;
                                            counterpartySectorCode?: ...;
                                            countryOfBirth?: ...;
                                            creationDate?: ...;
                                            customerTypeCode?: ...;
                                            deathDate?: ...;
                                            dependantPersons?: ...;
                                            educationCode?: ...;
                                            email?: ...;
                                            employmentTimeCode?: ...;
                                            fixedEmploymentLength?: ...;
                                            forgotten?: ...;
                                            fullName?: ...;
                                            givenName?: ...;
                                            housingTypeCode?: ...;
                                            idCountryCode?: ...;
                                            idNumber?: ...;
                                            inactivationDate?: ...;
                                            insertedDTime?: ...;
                                            intraOrgCode?: ...;
                                            language?: ...;
                                            legalForm?: ...;
                                            liquidationDate?: ...;
                                            mainPersonId?: ...;
                                            maritalStatusCode?: ...;
                                            middleName?: ...;
                                            name?: ...;
                                            nationality?: ...;
                                            pep?: ...;
                                            pepExplanation?: ...;
                                            personGroupCodes?: ...;
                                            personId?: ...;
                                            personTypeCode?: ...;
                                            phoneCountryCode?: ...;
                                            phoneNumber?: ...;
                                            placeOfBirth?: ...;
                                            registrationDate?: ...;
                                            residencyCountryCode?: ...;
                                            sex?: ...;
                                            source?: ...;
                                            statusCode?: ...;
                                            statusCodeReason?: ...;
                                            surname?: ...;
                                            taxResidencyCountry?: ...;
                                            tenantCode?: ...;
                                            tradingName?: ...;
                                            usResident?: ...;
                                            webAddress?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v2/payments/{paymentId}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { paymentId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accountId?: string
                                    | null;
                                    amlDeclineReason?: string | null;
                                    amlMonitoringEnabled?: boolean | null;
                                    autoConfirm?: boolean | null;
                                    cancellationRequestStatusCode?: string | null;
                                    cancelReason?: string | null;
                                    cancelRefuseReason?: string | null;
                                    categoryPurposeCode?: string | null;
                                    chargeBearer?: string | null;
                                    contractSource?: {
                                        contractNumber?: (...) | (...);
                                        sourceName?: (...) | (...);
                                        sourceRef?: (...) | (...);
                                    };
                                    counterpartyOriginalIban?: string
                                    | null;
                                    details?: string | null;
                                    directionCode?: string | null;
                                    endToEndId?: string | null;
                                    errorCode?: string | null;
                                    fees?:
                                        | {
                                            actualFeeMoney?: ...;
                                            deferredFee?: ...;
                                            estimatedFee?: ...;
                                            feeMoney?: ...;
                                            feeTypeCode?: ...;
                                        }[]
                                        | null;
                                    fileImportLineNumber?: number
                                    | null;
                                    fxPayment?: {
                                        coverMoney?: (...) | (...);
                                        exchangeRate?: (...) | (...) | (...);
                                        fixedSide?: (...) | (...) | (...);
                                        fxQuoteRequestId?: (...) | (...) | (...);
                                        paymentMoney?: (...) | (...);
                                        reservationMoney?: (...) | (...);
                                        serviceProviderResult?: (...) | (...);
                                    };
                                    fxPaymentFlag?: boolean
                                    | null;
                                    insertedDateTime?: string | null;
                                    labels?: string[] | null;
                                    lastStatusRequestDate?: string | null;
                                    money?: { amount?: (...) | (...); currencyCode: string };
                                    paymentCancellationReasonCode?: string | null;
                                    paymentId?: string | null;
                                    paymentParties?:
                                        | {
                                            accountNumber?: ...;
                                            accountNumberCountryCode?: ...;
                                            accountNumberSubtype?: ...;
                                            address?: ...;
                                            financialInstitutionId?: ...;
                                            givenName?: ...;
                                            name?: ...;
                                            partyIdentification?: ...;
                                            paymentPartyId?: ...;
                                            personTypeCode?: ...;
                                            roleCode?: ...;
                                            surname?: ...;
                                            tenantCode?: ...;
                                            typeCode?: ...;
                                        }[]
                                        | null;
                                    paymentSchemeElements?: | {
                                        fieldValue?: ...;
                                        fieldValueCountryCode?: ...;
                                        fieldValueSchemeTypeCode?: ...;
                                        fieldValueTypeCode?: ...;
                                        includeToMetaInfo?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                    paymentServiceProviderCode?: string
                                    | null;
                                    paymentTypeCode?: string | null;
                                    postingDate?: string | null;
                                    preferredPaymentScheme?: string | null;
                                    purposeCode?: string | null;
                                    referenceNumber?: string | null;
                                    residencyCountryCode?: string | null;
                                    returnComment?: string | null;
                                    returnReason?: string | null;
                                    returnSettlementDate?: string | null;
                                    returnStatusCode?: string | null;
                                    selectedPaymentScheme?: string | null;
                                    settlementDate?: string | null;
                                    settlementErrorCode?: string | null;
                                    settlementPaymentScheme?: string | null;
                                    settlementStatusCode?: string | null;
                                    source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                    statusCode?: string | null;
                                    tenantCode?: string | null;
                                    uetr?: string | null;
                                    valueDate?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v2/payments/{paymentId}/return": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { paymentId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            comment?: string
                            | null;
                            returnDescription?: string | null;
                            returnReason?: string | null;
                        };
                        "application/json": {
                            comment?: string
                            | null;
                            returnDescription?: string | null;
                            returnReason?: string | null;
                        };
                        "text/json": {
                            comment?: string
                            | null;
                            returnDescription?: string | null;
                            returnReason?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v2/persons": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            addresses?: | {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                moveInDate?: string
                                | null;
                                stateRegion?: string | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[]
                            | null;
                            birthDate?: string
                            | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customFields?: { [key: string]: unknown } | null;
                            documents?:
                                | {
                                    documentTypeCode: | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "RESIDENCE_PERMIT";
                                    expiryDate?: string
                                    | null;
                                    issuingCountry: string;
                                    number: string;
                                    validityRange?: { endTime?: ...; startTime?: ... };
                                }[]
                                | null;
                            email?: string
                            | null;
                            financialData?:
                                | {
                                    currencyCode?: string
                                    | null;
                                    currentPeriodValue?: number | null;
                                    description?: string | null;
                                    financialDataTypeCode: string;
                                    financialDataValueTypeCode:
                                        | "CURRENCY"
                                        | "NUMBER"
                                        | "NUMBER_RANGE"
                                        | "CURRENCY_RANGE";
                                    nextPeriodEstimateValue?: number
                                    | null;
                                    period?: number | null;
                                    periodRange?: { endDate?: ...; startDate?: ... };
                                    valueRange?: { endValue?: ...; startValue?: ... };
                                }[]
                                | null;
                            givenName?: string
                            | null;
                            identificationNumbers?:
                                | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                                | null;
                            intraOrgCode?: string | null;
                            language?: string | null;
                            legalEntityIdentifier?: {
                                lastUpdateDate?: string | null;
                                leiCode: string;
                                localOperatingUnit: string;
                                registrationDate: string;
                            };
                            middleName?: string
                            | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personTypeCode: "P" | "L";
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            relationships?:
                                | {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean;
                                    customFields?: { [key: ...]: ... } | null;
                                    idCountryCode: string;
                                    idNumber: string;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    relationTypeCode:
                                        | "REPRESENTATIVE"
                                        | "SHAREHOLDER"
                                        | "DIRECTOR"
                                        | "MEMBER_OF_BOARD"
                                        | "SUPERVISORY_BOARD_MEMBER"
                                        | "EXECUTIVE_OFFICER"
                                        | "ACCOUNTANT";
                                    representingRange: {
                                        endDate?: (...)
                                        | (...)
                                        | (...);
                                        startDate?: (...) | (...) | (...);
                                    };
                                    role?: string
                                    | null;
                                    source?: { sourceName: ...; sourceRef: ... };
                                    statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                                }[]
                                | null;
                            residencyCountryCode?: string
                            | null;
                            risks?:
                                | {
                                    date?: string
                                    | null;
                                    riskLevelCode: string;
                                    riskTypeCode: string;
                                    source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                                    value?: number | null;
                                }[]
                                | null;
                            sex?: "M"
                            | "F"
                            | "O";
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            surname?: string
                            | null;
                            taxNumbers?:
                                | {
                                    primary?: boolean
                                    | null;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode?:
                                        | "TAX_IDENTIFICATION_NUMBER"
                                        | "VAT_NUMBER"
                                        | "NATIONAL_INSURANCE_NUMBER"
                                        | "TAX_CODE"
                                        | "SSN";
                                }[]
                                | null;
                            taxResidencyCountry?: string
                            | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                        "application/json": {
                            addresses?: | {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                moveInDate?: string
                                | null;
                                stateRegion?: string | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[]
                            | null;
                            birthDate?: string
                            | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customFields?: { [key: string]: unknown } | null;
                            documents?:
                                | {
                                    documentTypeCode: | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "RESIDENCE_PERMIT";
                                    expiryDate?: string
                                    | null;
                                    issuingCountry: string;
                                    number: string;
                                    validityRange?: { endTime?: ...; startTime?: ... };
                                }[]
                                | null;
                            email?: string
                            | null;
                            financialData?:
                                | {
                                    currencyCode?: string
                                    | null;
                                    currentPeriodValue?: number | null;
                                    description?: string | null;
                                    financialDataTypeCode: string;
                                    financialDataValueTypeCode:
                                        | "CURRENCY"
                                        | "NUMBER"
                                        | "NUMBER_RANGE"
                                        | "CURRENCY_RANGE";
                                    nextPeriodEstimateValue?: number
                                    | null;
                                    period?: number | null;
                                    periodRange?: { endDate?: ...; startDate?: ... };
                                    valueRange?: { endValue?: ...; startValue?: ... };
                                }[]
                                | null;
                            givenName?: string
                            | null;
                            identificationNumbers?:
                                | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                                | null;
                            intraOrgCode?: string | null;
                            language?: string | null;
                            legalEntityIdentifier?: {
                                lastUpdateDate?: string | null;
                                leiCode: string;
                                localOperatingUnit: string;
                                registrationDate: string;
                            };
                            middleName?: string
                            | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personTypeCode: "P" | "L";
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            relationships?:
                                | {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean;
                                    customFields?: { [key: ...]: ... } | null;
                                    idCountryCode: string;
                                    idNumber: string;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    relationTypeCode:
                                        | "REPRESENTATIVE"
                                        | "SHAREHOLDER"
                                        | "DIRECTOR"
                                        | "MEMBER_OF_BOARD"
                                        | "SUPERVISORY_BOARD_MEMBER"
                                        | "EXECUTIVE_OFFICER"
                                        | "ACCOUNTANT";
                                    representingRange: {
                                        endDate?: (...)
                                        | (...)
                                        | (...);
                                        startDate?: (...) | (...) | (...);
                                    };
                                    role?: string
                                    | null;
                                    source?: { sourceName: ...; sourceRef: ... };
                                    statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                                }[]
                                | null;
                            residencyCountryCode?: string
                            | null;
                            risks?:
                                | {
                                    date?: string
                                    | null;
                                    riskLevelCode: string;
                                    riskTypeCode: string;
                                    source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                                    value?: number | null;
                                }[]
                                | null;
                            sex?: "M"
                            | "F"
                            | "O";
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            surname?: string
                            | null;
                            taxNumbers?:
                                | {
                                    primary?: boolean
                                    | null;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode?:
                                        | "TAX_IDENTIFICATION_NUMBER"
                                        | "VAT_NUMBER"
                                        | "NATIONAL_INSURANCE_NUMBER"
                                        | "TAX_CODE"
                                        | "SSN";
                                }[]
                                | null;
                            taxResidencyCountry?: string
                            | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                        "text/json": {
                            addresses?: | {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                moveInDate?: string
                                | null;
                                stateRegion?: string | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[]
                            | null;
                            birthDate?: string
                            | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customFields?: { [key: string]: unknown } | null;
                            documents?:
                                | {
                                    documentTypeCode: | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "RESIDENCE_PERMIT";
                                    expiryDate?: string
                                    | null;
                                    issuingCountry: string;
                                    number: string;
                                    validityRange?: { endTime?: ...; startTime?: ... };
                                }[]
                                | null;
                            email?: string
                            | null;
                            financialData?:
                                | {
                                    currencyCode?: string
                                    | null;
                                    currentPeriodValue?: number | null;
                                    description?: string | null;
                                    financialDataTypeCode: string;
                                    financialDataValueTypeCode:
                                        | "CURRENCY"
                                        | "NUMBER"
                                        | "NUMBER_RANGE"
                                        | "CURRENCY_RANGE";
                                    nextPeriodEstimateValue?: number
                                    | null;
                                    period?: number | null;
                                    periodRange?: { endDate?: ...; startDate?: ... };
                                    valueRange?: { endValue?: ...; startValue?: ... };
                                }[]
                                | null;
                            givenName?: string
                            | null;
                            identificationNumbers?:
                                | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                                | null;
                            intraOrgCode?: string | null;
                            language?: string | null;
                            legalEntityIdentifier?: {
                                lastUpdateDate?: string | null;
                                leiCode: string;
                                localOperatingUnit: string;
                                registrationDate: string;
                            };
                            middleName?: string
                            | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personTypeCode: "P" | "L";
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            relationships?:
                                | {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean;
                                    customFields?: { [key: ...]: ... } | null;
                                    idCountryCode: string;
                                    idNumber: string;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    relationTypeCode:
                                        | "REPRESENTATIVE"
                                        | "SHAREHOLDER"
                                        | "DIRECTOR"
                                        | "MEMBER_OF_BOARD"
                                        | "SUPERVISORY_BOARD_MEMBER"
                                        | "EXECUTIVE_OFFICER"
                                        | "ACCOUNTANT";
                                    representingRange: {
                                        endDate?: (...)
                                        | (...)
                                        | (...);
                                        startDate?: (...) | (...) | (...);
                                    };
                                    role?: string
                                    | null;
                                    source?: { sourceName: ...; sourceRef: ... };
                                    statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                                }[]
                                | null;
                            residencyCountryCode?: string
                            | null;
                            risks?:
                                | {
                                    date?: string
                                    | null;
                                    riskLevelCode: string;
                                    riskTypeCode: string;
                                    source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                                    value?: number | null;
                                }[]
                                | null;
                            sex?: "M"
                            | "F"
                            | "O";
                            source?: {
                                sourceLink?: string | null;
                                sourceName: string;
                                sourceRef: string;
                            };
                            surname?: string
                            | null;
                            taxNumbers?:
                                | {
                                    primary?: boolean
                                    | null;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode?:
                                        | "TAX_IDENTIFICATION_NUMBER"
                                        | "VAT_NUMBER"
                                        | "NATIONAL_INSURANCE_NUMBER"
                                        | "TAX_CODE"
                                        | "SSN";
                                }[]
                                | null;
                            taxResidencyCountry?: string
                            | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    additionalContacts?:
                                        | {
                                            additionalContactId?: ...;
                                            contactTypeCode?: ...;
                                            description?: ...;
                                            email?: ...;
                                            personId?: ...;
                                            phoneCountryCode?: ...;
                                            phoneNumber?: ...;
                                            preferredMethodOfContact?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    additionalInfo?: {
                                        birthDate?: (...)
                                        | (...)
                                        | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    addresses?: | {
                                        addressId?: ...;
                                        addressTypeCode?: ...;
                                        apartmentNumber?: ...;
                                        buildingName?: ...;
                                        buildingNumber?: ...;
                                        cityCounty?: ...;
                                        countryCode?: ...;
                                        department?: ...;
                                        district?: ...;
                                        floor?: ...;
                                        moveInDate?: ...;
                                        personId?: ...;
                                        postBox?: ...;
                                        stateRegion?: ...;
                                        street1?: ...;
                                        street2?: ...;
                                        streetName?: ...;
                                        structured?: ...;
                                        subDepartment?: ...;
                                        townLocationName?: ...;
                                        validityRange?: ...;
                                        zip?: ...;
                                    }[]
                                    | null;
                                    creationDate?: string
                                    | null;
                                    documents?:
                                        | {
                                            docuId?: ...;
                                            documentTypeCode?: ...;
                                            expiryDate?: ...;
                                            issuingCountry?: ...;
                                            number?: ...;
                                            personId?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    forgotten?: boolean
                                    | null;
                                    fullName?: string | null;
                                    home?: {
                                        buildingTypeCode?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                    };
                                    identificationNumbers?: | {
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        idNumberId?: ...;
                                        personId?: ...;
                                        primary?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    legalForm?: string
                                    | null;
                                    mainPersonId?: string | null;
                                    personalInfo?: {
                                        dependantPersons?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                    };
                                    personGroupCodes?: | {
                                        personGroupCode: ...;
                                        personGroupId?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    personId?: string
                                    | null;
                                    relationships?:
                                        | {
                                            additionalData?: ...;
                                            beneficiary?: ...;
                                            parent?: ...;
                                            parentPersonId?: ...;
                                            percentageOfShares?: ...;
                                            percentageOfSignature?: ...;
                                            person?: ...;
                                            personId?: ...;
                                            personRelationshipId?: ...;
                                            relationTypeCode?: ...;
                                            representingRange?: ...;
                                            role?: ...;
                                            statusCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    source?: {
                                        sourceLink?: (...)
                                        | (...)
                                        | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    statusCode?: string
                                    | null;
                                    taxNumbers?:
                                        | {
                                            personId?: ...;
                                            primary?: ...;
                                            taxCountryCode?: ...;
                                            taxNumber?: ...;
                                            taxNumberId?: ...;
                                            taxNumberTypeCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    tenantCode?: string
                                    | null;
                                    work?: {
                                        activityCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v2/persons/{personId}/addresses": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        };
                        "application/json": {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        };
                        "text/json": {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    addressId?: string
                                    | null;
                                    addressTypeCode?: string | null;
                                    apartmentNumber?: string | null;
                                    buildingName?: string | null;
                                    buildingNumber?: string | null;
                                    cityCounty?: string | null;
                                    countryCode?: string | null;
                                    department?: string | null;
                                    district?: string | null;
                                    floor?: string | null;
                                    moveInDate?: string | null;
                                    personId?: string | null;
                                    postBox?: string | null;
                                    stateRegion?: string | null;
                                    street1?: string | null;
                                    street2?: string | null;
                                    streetName?: string | null;
                                    structured?: boolean | null;
                                    subDepartment?: string | null;
                                    townLocationName?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                    zip?: string
                                    | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v2/persons/{personId}/addresses/{addressId}": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { addressId: string; personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        };
                        "application/json": {
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        };
                        "text/json": {
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    addressId?: string
                                    | null;
                                    addressTypeCode?: string | null;
                                    apartmentNumber?: string | null;
                                    buildingName?: string | null;
                                    buildingNumber?: string | null;
                                    cityCounty?: string | null;
                                    countryCode?: string | null;
                                    department?: string | null;
                                    district?: string | null;
                                    floor?: string | null;
                                    moveInDate?: string | null;
                                    personId?: string | null;
                                    postBox?: string | null;
                                    stateRegion?: string | null;
                                    street1?: string | null;
                                    street2?: string | null;
                                    streetName?: string | null;
                                    structured?: boolean | null;
                                    subDepartment?: string | null;
                                    townLocationName?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                    zip?: string
                                    | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/v2/persons/{personId}/relations": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: { includeAccessRestricted?: boolean };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: | {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean | null;
                                    parent?: {
                                        accessRestricted?: ...;
                                        activityCode?: ...;
                                        birthDate?: ...;
                                        buildingTypeCode?: ...;
                                        businessAreaCodes?: ...;
                                        businessModelDescription?: ...;
                                        counterpartySectorCode?: ...;
                                        countryOfBirth?: ...;
                                        creationDate?: ...;
                                        customerTypeCode?: ...;
                                        deathDate?: ...;
                                        dependantPersons?: ...;
                                        educationCode?: ...;
                                        email?: ...;
                                        employmentTimeCode?: ...;
                                        fixedEmploymentLength?: ...;
                                        forgotten?: ...;
                                        fullName?: ...;
                                        givenName?: ...;
                                        housingTypeCode?: ...;
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        inactivationDate?: ...;
                                        insertedDTime?: ...;
                                        intraOrgCode?: ...;
                                        language?: ...;
                                        legalForm?: ...;
                                        liquidationDate?: ...;
                                        mainPersonId?: ...;
                                        maritalStatusCode?: ...;
                                        middleName?: ...;
                                        name?: ...;
                                        nationality?: ...;
                                        pep?: ...;
                                        pepExplanation?: ...;
                                        personGroupCodes?: ...;
                                        personId?: ...;
                                        personTypeCode?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        placeOfBirth?: ...;
                                        registrationDate?: ...;
                                        residencyCountryCode?: ...;
                                        sex?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusCodeReason?: ...;
                                        surname?: ...;
                                        taxResidencyCountry?: ...;
                                        tenantCode?: ...;
                                        tradingName?: ...;
                                        usResident?: ...;
                                        webAddress?: ...;
                                    };
                                    parentPersonId?: string
                                    | null;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    person?: {
                                        accessRestricted?: ...;
                                        activityCode?: ...;
                                        birthDate?: ...;
                                        buildingTypeCode?: ...;
                                        businessAreaCodes?: ...;
                                        businessModelDescription?: ...;
                                        counterpartySectorCode?: ...;
                                        countryOfBirth?: ...;
                                        creationDate?: ...;
                                        customerTypeCode?: ...;
                                        deathDate?: ...;
                                        dependantPersons?: ...;
                                        educationCode?: ...;
                                        email?: ...;
                                        employmentTimeCode?: ...;
                                        fixedEmploymentLength?: ...;
                                        forgotten?: ...;
                                        fullName?: ...;
                                        givenName?: ...;
                                        housingTypeCode?: ...;
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        inactivationDate?: ...;
                                        insertedDTime?: ...;
                                        intraOrgCode?: ...;
                                        language?: ...;
                                        legalForm?: ...;
                                        liquidationDate?: ...;
                                        mainPersonId?: ...;
                                        maritalStatusCode?: ...;
                                        middleName?: ...;
                                        name?: ...;
                                        nationality?: ...;
                                        pep?: ...;
                                        pepExplanation?: ...;
                                        personGroupCodes?: ...;
                                        personId?: ...;
                                        personTypeCode?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        placeOfBirth?: ...;
                                        registrationDate?: ...;
                                        residencyCountryCode?: ...;
                                        sex?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusCodeReason?: ...;
                                        surname?: ...;
                                        taxResidencyCountry?: ...;
                                        tenantCode?: ...;
                                        tradingName?: ...;
                                        usResident?: ...;
                                        webAddress?: ...;
                                    };
                                    personId?: string
                                    | null;
                                    personRelationshipId?: string | null;
                                    relationTypeCode?: string | null;
                                    representingRange?: { endDate?: ...; startDate?: ... };
                                    role?: string | null;
                                    statusCode?: string | null;
                                    validityRange?: { endTime?: ...; startTime?: ... };
                                }[]
                                | null;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v2/persons/{personId}/relations/{personRelationshipId}": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string; personRelationshipId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            representingRange: {
                                endDate?: string | null;
                                startDate?: string | null;
                            };
                            role?: string
                            | null;
                            statusCode: "ACTIVE" | "INACTIVE";
                        };
                        "application/json": {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            representingRange: {
                                endDate?: string | null;
                                startDate?: string | null;
                            };
                            role?: string
                            | null;
                            statusCode: "ACTIVE" | "INACTIVE";
                        };
                        "text/json": {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            representingRange: {
                                endDate?: string | null;
                                startDate?: string | null;
                            };
                            role?: string
                            | null;
                            statusCode: "ACTIVE" | "INACTIVE";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    additionalData?: string
                                    | null;
                                    beneficiary?: boolean | null;
                                    parent?: {
                                        accessRestricted?: (...) | (...) | (...) | (...);
                                        activityCode?: (...) | (...) | (...);
                                        birthDate?: (...) | (...) | (...);
                                        buildingTypeCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        creationDate?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                        forgotten?: (...) | (...) | (...) | (...);
                                        fullName?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                        idCountryCode?: (...) | (...) | (...);
                                        idNumber?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        insertedDTime?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        personGroupCodes?: (...) | (...) | (...);
                                        personId?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        source?: (...) | (...);
                                        statusCode?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tenantCode?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    parentPersonId?: string
                                    | null;
                                    percentageOfShares?: number | null;
                                    percentageOfSignature?: number | null;
                                    person?: {
                                        accessRestricted?: (...) | (...) | (...) | (...);
                                        activityCode?: (...) | (...) | (...);
                                        birthDate?: (...) | (...) | (...);
                                        buildingTypeCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        creationDate?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                        forgotten?: (...) | (...) | (...) | (...);
                                        fullName?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                        idCountryCode?: (...) | (...) | (...);
                                        idNumber?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        insertedDTime?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        personGroupCodes?: (...) | (...) | (...);
                                        personId?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        source?: (...) | (...);
                                        statusCode?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tenantCode?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    personId?: string
                                    | null;
                                    personRelationshipId?: string | null;
                                    relationTypeCode?: string | null;
                                    representingRange?: {
                                        endDate?: (...) | (...) | (...);
                                        startDate?: (...) | (...) | (...);
                                    };
                                    role?: string
                                    | null;
                                    statusCode?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/v2/persons/custom-fields/value": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            entityName: string;
                            entityRef: string;
                            fieldId: string;
                            fieldValue: unknown;
                        };
                        "application/json": {
                            entityName: string;
                            entityRef: string;
                            fieldId: string;
                            fieldValue: unknown;
                        };
                        "text/json": {
                            entityName: string;
                            entityRef: string;
                            fieldId: string;
                            fieldValue: unknown;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            entityName: string;
                            entityRef: string;
                            fieldId: string;
                            fieldValue: unknown;
                        };
                        "application/json": {
                            entityName: string;
                            entityRef: string;
                            fieldId: string;
                            fieldValue: unknown;
                        };
                        "text/json": {
                            entityName: string;
                            entityRef: string;
                            fieldId: string;
                            fieldValue: unknown;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/v2/persons/search": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            addressTypeCode?: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            birthDate?: string
                            | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            country?: string | null;
                            creationDateFrom?: string | null;
                            creationDateTo?: string | null;
                            email?: string | null;
                            firstName?: string | null;
                            globalSearch?: string | null;
                            idNumber?: string | null;
                            includeAccessRestricted?: boolean | null;
                            intraOrgCode?: string | null;
                            lastName?: string | null;
                            legalForm?: string | null;
                            name?: string | null;
                            pageNumber?: number;
                            pageSize?: number;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personId?: string | null;
                            personIds?: string[] | null;
                            personTypeCode?: "P" | "L";
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sort?: { field?: string | null; order?: string | null }[] | null;
                            statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                            statusCodeReason?: string | null;
                            statusCodes?: string[] | null;
                            tradingName?: string | null;
                            webAddress?: string | null;
                            zip?: string | null;
                        };
                        "application/json": {
                            addressTypeCode?: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            birthDate?: string
                            | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            country?: string | null;
                            creationDateFrom?: string | null;
                            creationDateTo?: string | null;
                            email?: string | null;
                            firstName?: string | null;
                            globalSearch?: string | null;
                            idNumber?: string | null;
                            includeAccessRestricted?: boolean | null;
                            intraOrgCode?: string | null;
                            lastName?: string | null;
                            legalForm?: string | null;
                            name?: string | null;
                            pageNumber?: number;
                            pageSize?: number;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personId?: string | null;
                            personIds?: string[] | null;
                            personTypeCode?: "P" | "L";
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sort?: { field?: string | null; order?: string | null }[] | null;
                            statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                            statusCodeReason?: string | null;
                            statusCodes?: string[] | null;
                            tradingName?: string | null;
                            webAddress?: string | null;
                            zip?: string | null;
                        };
                        "text/json": {
                            addressTypeCode?: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            birthDate?: string
                            | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            country?: string | null;
                            creationDateFrom?: string | null;
                            creationDateTo?: string | null;
                            email?: string | null;
                            firstName?: string | null;
                            globalSearch?: string | null;
                            idNumber?: string | null;
                            includeAccessRestricted?: boolean | null;
                            intraOrgCode?: string | null;
                            lastName?: string | null;
                            legalForm?: string | null;
                            name?: string | null;
                            pageNumber?: number;
                            pageSize?: number;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personId?: string | null;
                            personIds?: string[] | null;
                            personTypeCode?: "P" | "L";
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sort?: { field?: string | null; order?: string | null }[] | null;
                            statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                            statusCodeReason?: string | null;
                            statusCodes?: string[] | null;
                            tradingName?: string | null;
                            webAddress?: string | null;
                            zip?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    values?:
                                        | {
                                            accessRestricted?: ...;
                                            activityCode?: ...;
                                            birthDate?: ...;
                                            buildingTypeCode?: ...;
                                            businessAreaCodes?: ...;
                                            businessModelDescription?: ...;
                                            counterpartySectorCode?: ...;
                                            countryOfBirth?: ...;
                                            creationDate?: ...;
                                            customerTypeCode?: ...;
                                            deathDate?: ...;
                                            dependantPersons?: ...;
                                            educationCode?: ...;
                                            email?: ...;
                                            employmentTimeCode?: ...;
                                            fixedEmploymentLength?: ...;
                                            forgotten?: ...;
                                            fullName?: ...;
                                            givenName?: ...;
                                            housingTypeCode?: ...;
                                            idCountryCode?: ...;
                                            idNumber?: ...;
                                            inactivationDate?: ...;
                                            insertedDTime?: ...;
                                            intraOrgCode?: ...;
                                            language?: ...;
                                            legalForm?: ...;
                                            liquidationDate?: ...;
                                            mainPersonId?: ...;
                                            maritalStatusCode?: ...;
                                            middleName?: ...;
                                            name?: ...;
                                            nationality?: ...;
                                            pep?: ...;
                                            pepExplanation?: ...;
                                            personGroupCodes?: ...;
                                            personId?: ...;
                                            personTypeCode?: ...;
                                            phoneCountryCode?: ...;
                                            phoneNumber?: ...;
                                            placeOfBirth?: ...;
                                            registrationDate?: ...;
                                            residencyCountryCode?: ...;
                                            sex?: ...;
                                            source?: ...;
                                            statusCode?: ...;
                                            statusCodeReason?: ...;
                                            surname?: ...;
                                            taxResidencyCountry?: ...;
                                            tenantCode?: ...;
                                            tradingName?: ...;
                                            usResident?: ...;
                                            webAddress?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/accounts/{accountId}/payments": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { accountId: string };
                    query: {
                        amountFrom?: number;
                        amountTo?: number;
                        cancellationRequestStatusCodes?: string[];
                        contractNumber?: string;
                        counterpartyAccountNumber?: string;
                        currencyCodes?: string[];
                        details?: string;
                        directionCode?: string;
                        isNotSettled?: boolean;
                        isSettled?: boolean;
                        pageNumber: number;
                        pageSize: number;
                        paymentId?: string;
                        paymentServiceProviderCode?: string;
                        paymentTypeCodes?: string[];
                        postingDateFrom?: string;
                        postingDateTo?: string;
                        referenceNumber?: string;
                        sourceName?: string;
                        sourceRef?: string;
                        statusCodes?: string[];
                        valueDateFrom?: string;
                        valueDateTo?: string;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    values?:
                                        | {
                                            accountId?: ...;
                                            amlDeclineReason?: ...;
                                            amlMonitoringEnabled?: ...;
                                            autoConfirm?: ...;
                                            cancellationRequestStatusCode?: ...;
                                            cancelReason?: ...;
                                            cancelRefuseReason?: ...;
                                            categoryPurposeCode?: ...;
                                            chargeBearer?: ...;
                                            contractSource?: ...;
                                            counterpartyOriginalIban?: ...;
                                            details?: ...;
                                            directionCode?: ...;
                                            endToEndId?: ...;
                                            errorCode?: ...;
                                            fees?: ...;
                                            fileImportLineNumber?: ...;
                                            fxPayment?: ...;
                                            fxPaymentFlag?: ...;
                                            insertedDateTime?: ...;
                                            labels?: ...;
                                            lastStatusRequestDate?: ...;
                                            money?: ...;
                                            paymentCancellationReasonCode?: ...;
                                            paymentId?: ...;
                                            paymentParties?: ...;
                                            paymentSchemeElements?: ...;
                                            paymentServiceProviderCode?: ...;
                                            paymentTypeCode?: ...;
                                            postingDate?: ...;
                                            preferredPaymentScheme?: ...;
                                            purposeCode?: ...;
                                            referenceNumber?: ...;
                                            residencyCountryCode?: ...;
                                            returnComment?: ...;
                                            returnReason?: ...;
                                            returnSettlementDate?: ...;
                                            returnStatusCode?: ...;
                                            selectedPaymentScheme?: ...;
                                            settlementDate?: ...;
                                            settlementErrorCode?: ...;
                                            settlementPaymentScheme?: ...;
                                            settlementStatusCode?: ...;
                                            source?: ...;
                                            statusCode?: ...;
                                            tenantCode?: ...;
                                            uetr?: ...;
                                            valueDate?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/accounts/by-account-number": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query: {
                        accountNumberSubType: string;
                        accountNumberType: string;
                        accountNumberValue: string;
                        countryCode: string;
                        financialInstitutionIdType: string;
                        financialInstitutionIdValue: string;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    accountClassCode?: string | null;
                                    accountId?: string | null;
                                    accountName?: string | null;
                                    accountNumbers?:
                                        | {
                                            accountId?: ...;
                                            accountNumber: ...;
                                            accountNumberId?: ...;
                                            accountNumberSubtype?: ...;
                                            countryCode?: ...;
                                            defaultCurrencyCode?: ...;
                                            externalSyncEnabled?: ...;
                                            financialInstitutionId?: ...;
                                            statusCode?: ...;
                                            tenantCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    accountTypeCode?: | "CURRENCY"
                                    | "INTERNAL"
                                    | "SAVING"
                                    | "SHADOW"
                                    | "VIRTUAL";
                                    accountTypeSetupCode?: string
                                    | null;
                                    activationDate?: string | null;
                                    balances?:
                                        | {
                                            accountId: ...;
                                            availableBalanceAmount?: ...;
                                            availableBalanceInDefaultCcy?: ...;
                                            balanceAmount?: ...;
                                            balanceId: ...;
                                            currencyCode: ...;
                                            defaultCurrencyCode?: ...;
                                            negativeBalanceStartDate?: ...;
                                            overdraftLimitAmount?: ...;
                                            reservedAmount?: ...;
                                            tenantCode?: ...;
                                        }[]
                                        | null;
                                    bic?: string
                                    | null;
                                    counterpartySectorCode?: string | null;
                                    customerGroupCode?: string | null;
                                    defaultCurrencyCode?: string | null;
                                    iban?: string | null;
                                    interestMethodAssignmentCode?: string | null;
                                    intraOrgCode?: string | null;
                                    jurisdictionCountryCode?: string | null;
                                    masterAccountId?: string | null;
                                    personId?: string | null;
                                    personName?: string | null;
                                    personTypeCode?: string | null;
                                    productCode?: string | null;
                                    residencyCode?: string | null;
                                    serviceProviderCode?: string | null;
                                    source?: { sourceName: string; sourceRef: string };
                                    statusCode?:
                                        | "ACTIVE"
                                        | "INACTIVE"
                                        | "CLOSED"
                                        | "CREATED"
                                        | "BLOCKED"
                                        | "WAITING_FOR_CLOSURE_DECISION";
                                    statusReasonCode?: string
                                    | null;
                                    taxResidencyCountryCode?: string | null;
                                    tenantCode?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/payments/{paymentId}/cancel": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { paymentId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": { comment?: string
                        | null };
                        "application/json": { comment?: string | null };
                        "text/json": { comment?: string | null };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accountId?: string
                                    | null;
                                    amlDeclineReason?: string | null;
                                    amlMonitoringEnabled?: boolean | null;
                                    autoConfirm?: boolean | null;
                                    cancellationRequestStatusCode?: string | null;
                                    cancelReason?: string | null;
                                    cancelRefuseReason?: string | null;
                                    categoryPurposeCode?: string | null;
                                    chargeBearer?: string | null;
                                    contractSource?: {
                                        contractNumber?: (...) | (...);
                                        sourceName?: (...) | (...);
                                        sourceRef?: (...) | (...);
                                    };
                                    counterpartyOriginalIban?: string
                                    | null;
                                    details?: string | null;
                                    directionCode?: string | null;
                                    endToEndId?: string | null;
                                    errorCode?: string | null;
                                    fees?:
                                        | {
                                            actualFeeMoney?: ...;
                                            deferredFee?: ...;
                                            estimatedFee?: ...;
                                            feeMoney?: ...;
                                            feeTypeCode?: ...;
                                        }[]
                                        | null;
                                    fileImportLineNumber?: number
                                    | null;
                                    fxPayment?: {
                                        coverMoney?: (...) | (...);
                                        exchangeRate?: (...) | (...) | (...);
                                        fixedSide?: (...) | (...) | (...);
                                        fxQuoteRequestId?: (...) | (...) | (...);
                                        paymentMoney?: (...) | (...);
                                        reservationMoney?: (...) | (...);
                                        serviceProviderResult?: (...) | (...);
                                    };
                                    fxPaymentFlag?: boolean
                                    | null;
                                    insertedDateTime?: string | null;
                                    labels?: string[] | null;
                                    lastStatusRequestDate?: string | null;
                                    money?: { amount?: (...) | (...); currencyCode: string };
                                    paymentCancellationReasonCode?: string | null;
                                    paymentId?: string | null;
                                    paymentParties?:
                                        | {
                                            accountNumber?: ...;
                                            accountNumberCountryCode?: ...;
                                            accountNumberSubtype?: ...;
                                            address?: ...;
                                            financialInstitutionId?: ...;
                                            givenName?: ...;
                                            name?: ...;
                                            partyIdentification?: ...;
                                            paymentPartyId?: ...;
                                            personTypeCode?: ...;
                                            roleCode?: ...;
                                            surname?: ...;
                                            tenantCode?: ...;
                                            typeCode?: ...;
                                        }[]
                                        | null;
                                    paymentSchemeElements?: | {
                                        fieldValue?: ...;
                                        fieldValueCountryCode?: ...;
                                        fieldValueSchemeTypeCode?: ...;
                                        fieldValueTypeCode?: ...;
                                        includeToMetaInfo?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                    paymentServiceProviderCode?: string
                                    | null;
                                    paymentTypeCode?: string | null;
                                    postingDate?: string | null;
                                    preferredPaymentScheme?: string | null;
                                    purposeCode?: string | null;
                                    referenceNumber?: string | null;
                                    residencyCountryCode?: string | null;
                                    returnComment?: string | null;
                                    returnReason?: string | null;
                                    returnSettlementDate?: string | null;
                                    returnStatusCode?: string | null;
                                    selectedPaymentScheme?: string | null;
                                    settlementDate?: string | null;
                                    settlementErrorCode?: string | null;
                                    settlementPaymentScheme?: string | null;
                                    settlementStatusCode?: string | null;
                                    source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                    statusCode?: string | null;
                                    tenantCode?: string | null;
                                    uetr?: string | null;
                                    valueDate?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/payments/{paymentId}/confirm": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { paymentId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": { comment?: string
                        | null };
                        "application/json": { comment?: string | null };
                        "text/json": { comment?: string | null };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accountId?: string
                                    | null;
                                    amlDeclineReason?: string | null;
                                    amlMonitoringEnabled?: boolean | null;
                                    autoConfirm?: boolean | null;
                                    cancellationRequestStatusCode?: string | null;
                                    cancelReason?: string | null;
                                    cancelRefuseReason?: string | null;
                                    categoryPurposeCode?: string | null;
                                    chargeBearer?: string | null;
                                    contractSource?: {
                                        contractNumber?: (...) | (...);
                                        sourceName?: (...) | (...);
                                        sourceRef?: (...) | (...);
                                    };
                                    counterpartyOriginalIban?: string
                                    | null;
                                    details?: string | null;
                                    directionCode?: string | null;
                                    endToEndId?: string | null;
                                    errorCode?: string | null;
                                    fees?:
                                        | {
                                            actualFeeMoney?: ...;
                                            deferredFee?: ...;
                                            estimatedFee?: ...;
                                            feeMoney?: ...;
                                            feeTypeCode?: ...;
                                        }[]
                                        | null;
                                    fileImportLineNumber?: number
                                    | null;
                                    fxPayment?: {
                                        coverMoney?: (...) | (...);
                                        exchangeRate?: (...) | (...) | (...);
                                        fixedSide?: (...) | (...) | (...);
                                        fxQuoteRequestId?: (...) | (...) | (...);
                                        paymentMoney?: (...) | (...);
                                        reservationMoney?: (...) | (...);
                                        serviceProviderResult?: (...) | (...);
                                    };
                                    fxPaymentFlag?: boolean
                                    | null;
                                    insertedDateTime?: string | null;
                                    labels?: string[] | null;
                                    lastStatusRequestDate?: string | null;
                                    money?: { amount?: (...) | (...); currencyCode: string };
                                    paymentCancellationReasonCode?: string | null;
                                    paymentId?: string | null;
                                    paymentParties?:
                                        | {
                                            accountNumber?: ...;
                                            accountNumberCountryCode?: ...;
                                            accountNumberSubtype?: ...;
                                            address?: ...;
                                            financialInstitutionId?: ...;
                                            givenName?: ...;
                                            name?: ...;
                                            partyIdentification?: ...;
                                            paymentPartyId?: ...;
                                            personTypeCode?: ...;
                                            roleCode?: ...;
                                            surname?: ...;
                                            tenantCode?: ...;
                                            typeCode?: ...;
                                        }[]
                                        | null;
                                    paymentSchemeElements?: | {
                                        fieldValue?: ...;
                                        fieldValueCountryCode?: ...;
                                        fieldValueSchemeTypeCode?: ...;
                                        fieldValueTypeCode?: ...;
                                        includeToMetaInfo?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                    paymentServiceProviderCode?: string
                                    | null;
                                    paymentTypeCode?: string | null;
                                    postingDate?: string | null;
                                    preferredPaymentScheme?: string | null;
                                    purposeCode?: string | null;
                                    referenceNumber?: string | null;
                                    residencyCountryCode?: string | null;
                                    returnComment?: string | null;
                                    returnReason?: string | null;
                                    returnSettlementDate?: string | null;
                                    returnStatusCode?: string | null;
                                    selectedPaymentScheme?: string | null;
                                    settlementDate?: string | null;
                                    settlementErrorCode?: string | null;
                                    settlementPaymentScheme?: string | null;
                                    settlementStatusCode?: string | null;
                                    source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                    statusCode?: string | null;
                                    tenantCode?: string | null;
                                    uetr?: string | null;
                                    valueDate?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/payments/initialise": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            chargeBearer?: "DEBT";
                            details: string;
                            directionCode: string;
                            endToEndId?: string
                            | null;
                            money: { amount: number; currencyCode: "USD" };
                            paymentParties?:
                                | {
                                    accountId?: string
                                    | null;
                                    accountNumber?: { type: ...; value?: ... };
                                    accountNumberCountryCode?: string | null;
                                    accountNumberSubtype?: string | null;
                                    address?: {
                                        addressLine?: ...;
                                        addressTypeCode?: ...;
                                        cityCounty: ...;
                                        countryCode: ...;
                                        stateRegion?: ...;
                                        street1: ...;
                                        street2?: ...;
                                        zip?: ...;
                                    };
                                    financialInstitutionId?: string
                                    | null;
                                    givenName?: string | null;
                                    name?: string | null;
                                    partyIdentification?: {
                                        identificationTypeCode?: ...;
                                        identificationValue?: ...;
                                    };
                                    personTypeCode?: "P"
                                    | "L";
                                    surname?: string | null;
                                    typeCode?:
                                        | "OUR_PARTY"
                                        | "OUR_CORRESPONDENT"
                                        | "COUNTERPARTY"
                                        | "ORIGINAL_OUR_PARTY"
                                        | "OUR_PARTY_MASTER";
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: string
                                | null;
                                fieldValueCountryCode?: string | null;
                                fieldValueTypeCode?: string;
                                includeToMetaInfo?: string | null;
                            }[]
                            | null;
                            paymentTypeCode: "ACC2EXTERNAL"
                            | "ACC2ACC";
                            preferredPaymentScheme?:
                                | "LOCAL_US_ACH"
                                | "SWIFT_CROSSBORDER"
                                | "LOCAL_US_WIRE"
                                | "LOCAL_STABLECOIN";
                            purposeCode: string;
                            referenceNumber?: string
                            | null;
                            valueDate?: string | null;
                        };
                        "application/json": {
                            chargeBearer?: "DEBT";
                            details: string;
                            directionCode: string;
                            endToEndId?: string
                            | null;
                            money: { amount: number; currencyCode: "USD" };
                            paymentParties?:
                                | {
                                    accountId?: string
                                    | null;
                                    accountNumber?: { type: ...; value?: ... };
                                    accountNumberCountryCode?: string | null;
                                    accountNumberSubtype?: string | null;
                                    address?: {
                                        addressLine?: ...;
                                        addressTypeCode?: ...;
                                        cityCounty: ...;
                                        countryCode: ...;
                                        stateRegion?: ...;
                                        street1: ...;
                                        street2?: ...;
                                        zip?: ...;
                                    };
                                    financialInstitutionId?: string
                                    | null;
                                    givenName?: string | null;
                                    name?: string | null;
                                    partyIdentification?: {
                                        identificationTypeCode?: ...;
                                        identificationValue?: ...;
                                    };
                                    personTypeCode?: "P"
                                    | "L";
                                    surname?: string | null;
                                    typeCode?:
                                        | "OUR_PARTY"
                                        | "OUR_CORRESPONDENT"
                                        | "COUNTERPARTY"
                                        | "ORIGINAL_OUR_PARTY"
                                        | "OUR_PARTY_MASTER";
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: string
                                | null;
                                fieldValueCountryCode?: string | null;
                                fieldValueTypeCode?: string;
                                includeToMetaInfo?: string | null;
                            }[]
                            | null;
                            paymentTypeCode: "ACC2EXTERNAL"
                            | "ACC2ACC";
                            preferredPaymentScheme?:
                                | "LOCAL_US_ACH"
                                | "SWIFT_CROSSBORDER"
                                | "LOCAL_US_WIRE"
                                | "LOCAL_STABLECOIN";
                            purposeCode: string;
                            referenceNumber?: string
                            | null;
                            valueDate?: string | null;
                        };
                        "text/json": {
                            chargeBearer?: "DEBT";
                            details: string;
                            directionCode: string;
                            endToEndId?: string
                            | null;
                            money: { amount: number; currencyCode: "USD" };
                            paymentParties?:
                                | {
                                    accountId?: string
                                    | null;
                                    accountNumber?: { type: ...; value?: ... };
                                    accountNumberCountryCode?: string | null;
                                    accountNumberSubtype?: string | null;
                                    address?: {
                                        addressLine?: ...;
                                        addressTypeCode?: ...;
                                        cityCounty: ...;
                                        countryCode: ...;
                                        stateRegion?: ...;
                                        street1: ...;
                                        street2?: ...;
                                        zip?: ...;
                                    };
                                    financialInstitutionId?: string
                                    | null;
                                    givenName?: string | null;
                                    name?: string | null;
                                    partyIdentification?: {
                                        identificationTypeCode?: ...;
                                        identificationValue?: ...;
                                    };
                                    personTypeCode?: "P"
                                    | "L";
                                    surname?: string | null;
                                    typeCode?:
                                        | "OUR_PARTY"
                                        | "OUR_CORRESPONDENT"
                                        | "COUNTERPARTY"
                                        | "ORIGINAL_OUR_PARTY"
                                        | "OUR_PARTY_MASTER";
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: string
                                | null;
                                fieldValueCountryCode?: string | null;
                                fieldValueTypeCode?: string;
                                includeToMetaInfo?: string | null;
                            }[]
                            | null;
                            paymentTypeCode: "ACC2EXTERNAL"
                            | "ACC2ACC";
                            preferredPaymentScheme?:
                                | "LOCAL_US_ACH"
                                | "SWIFT_CROSSBORDER"
                                | "LOCAL_US_WIRE"
                                | "LOCAL_STABLECOIN";
                            purposeCode: string;
                            referenceNumber?: string
                            | null;
                            valueDate?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accountId?: string
                                    | null;
                                    amlDeclineReason?: string | null;
                                    amlMonitoringEnabled?: boolean | null;
                                    autoConfirm?: boolean | null;
                                    cancellationRequestStatusCode?: string | null;
                                    cancelReason?: string | null;
                                    cancelRefuseReason?: string | null;
                                    categoryPurposeCode?: string | null;
                                    chargeBearer?: string | null;
                                    contractSource?: {
                                        contractNumber?: (...) | (...);
                                        sourceName?: (...) | (...);
                                        sourceRef?: (...) | (...);
                                    };
                                    counterpartyOriginalIban?: string
                                    | null;
                                    details?: string | null;
                                    directionCode?: string | null;
                                    endToEndId?: string | null;
                                    errorCode?: string | null;
                                    fees?:
                                        | {
                                            actualFeeMoney?: ...;
                                            deferredFee?: ...;
                                            estimatedFee?: ...;
                                            feeMoney?: ...;
                                            feeTypeCode?: ...;
                                        }[]
                                        | null;
                                    fileImportLineNumber?: number
                                    | null;
                                    fxPayment?: {
                                        coverMoney?: (...) | (...);
                                        exchangeRate?: (...) | (...) | (...);
                                        fixedSide?: (...) | (...) | (...);
                                        fxQuoteRequestId?: (...) | (...) | (...);
                                        paymentMoney?: (...) | (...);
                                        reservationMoney?: (...) | (...);
                                        serviceProviderResult?: (...) | (...);
                                    };
                                    fxPaymentFlag?: boolean
                                    | null;
                                    insertedDateTime?: string | null;
                                    labels?: string[] | null;
                                    lastStatusRequestDate?: string | null;
                                    money?: { amount?: (...) | (...); currencyCode: string };
                                    paymentCancellationReasonCode?: string | null;
                                    paymentId?: string | null;
                                    paymentParties?:
                                        | {
                                            accountNumber?: ...;
                                            accountNumberCountryCode?: ...;
                                            accountNumberSubtype?: ...;
                                            address?: ...;
                                            financialInstitutionId?: ...;
                                            givenName?: ...;
                                            name?: ...;
                                            partyIdentification?: ...;
                                            paymentPartyId?: ...;
                                            personTypeCode?: ...;
                                            roleCode?: ...;
                                            surname?: ...;
                                            tenantCode?: ...;
                                            typeCode?: ...;
                                        }[]
                                        | null;
                                    paymentSchemeElements?: | {
                                        fieldValue?: ...;
                                        fieldValueCountryCode?: ...;
                                        fieldValueSchemeTypeCode?: ...;
                                        fieldValueTypeCode?: ...;
                                        includeToMetaInfo?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                    paymentServiceProviderCode?: string
                                    | null;
                                    paymentTypeCode?: string | null;
                                    postingDate?: string | null;
                                    preferredPaymentScheme?: string | null;
                                    purposeCode?: string | null;
                                    referenceNumber?: string | null;
                                    residencyCountryCode?: string | null;
                                    returnComment?: string | null;
                                    returnReason?: string | null;
                                    returnSettlementDate?: string | null;
                                    returnStatusCode?: string | null;
                                    selectedPaymentScheme?: string | null;
                                    settlementDate?: string | null;
                                    settlementErrorCode?: string | null;
                                    settlementPaymentScheme?: string | null;
                                    settlementStatusCode?: string | null;
                                    source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                    statusCode?: string | null;
                                    tenantCode?: string | null;
                                    uetr?: string | null;
                                    valueDate?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/persons/{personId}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    activityCode?: string | null;
                                    birthDate?: string | null;
                                    buildingTypeCode?: string | null;
                                    businessAreaCodes?: string[] | null;
                                    businessModelDescription?: string | null;
                                    counterpartySectorCode?: string | null;
                                    countryOfBirth?: string | null;
                                    creationDate?: string | null;
                                    customerTypeCode?: string | null;
                                    deathDate?: string | null;
                                    dependantPersons?: number | null;
                                    educationCode?: string | null;
                                    email?: string | null;
                                    employmentTimeCode?: string | null;
                                    fixedEmploymentLength?: number | null;
                                    forgotten?: boolean | null;
                                    fullName?: string | null;
                                    givenName?: string | null;
                                    housingTypeCode?: string | null;
                                    idCountryCode?: string | null;
                                    idNumber?: string | null;
                                    inactivationDate?: string | null;
                                    insertedDTime?: string | null;
                                    intraOrgCode?: string | null;
                                    language?: string | null;
                                    legalForm?: string | null;
                                    liquidationDate?: string | null;
                                    mainPersonId?: string | null;
                                    maritalStatusCode?: string | null;
                                    middleName?: string | null;
                                    name?: string | null;
                                    nationality?: string | null;
                                    pep?: boolean | null;
                                    pepExplanation?: string | null;
                                    personGroupCodes?: string[] | null;
                                    personId?: string | null;
                                    personTypeCode?: string | null;
                                    phoneCountryCode?: string | null;
                                    phoneNumber?: string | null;
                                    placeOfBirth?: string | null;
                                    registrationDate?: string | null;
                                    residencyCountryCode?: string | null;
                                    sex?: string | null;
                                    source?: {
                                        sourceLink?: (...) | (...) | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    statusCode?: string
                                    | null;
                                    statusCodeReason?: string | null;
                                    surname?: string | null;
                                    taxResidencyCountry?: string | null;
                                    tenantCode?: string | null;
                                    tradingName?: string | null;
                                    usResident?: boolean | null;
                                    webAddress?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v3/transactions/{transactionId}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { transactionId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accountId?: string
                                    | null;
                                    accountTransactionId?: string | null;
                                    amount?: number | null;
                                    contractSource?: {
                                        contractNumber: string;
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    counterparty?: {
                                        accountNumber?: (...)
                                        | (...);
                                        accountNumberCountryCode?: (...) | (...) | (...);
                                        accountNumberSubtype?: (...) | (...) | (...);
                                        financialInstitutionId?: (...) | (...);
                                        name?: (...) | (...) | (...);
                                    };
                                    createdDTime?: string
                                    | null;
                                    currencyCode?: string | null;
                                    customBookingAllowed?: boolean | null;
                                    details?: string | null;
                                    directionCode?: "IN" | "OUT";
                                    domainCode?: string | null;
                                    endToEndId?: string | null;
                                    familyCode?: string | null;
                                    filingCode?: string | null;
                                    groupId?: string | null;
                                    initialBalanceAmount?: number | null;
                                    labels?: string[] | null;
                                    merchantInfo?: string | null;
                                    metaInfo?: string | null;
                                    paymentServiceProviderCode?: string | null;
                                    postingDate?: string | null;
                                    referenceNumber?: string | null;
                                    reservationId?: string | null;
                                    reversal?: boolean | null;
                                    reversalTransactionId?: string | null;
                                    reversed?: boolean | null;
                                    reversedByTransactionId?: string | null;
                                    source?: {
                                        sourceLink?: (...) | (...) | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    subFamilyCode?: string
                                    | null;
                                    tenantCode?: string | null;
                                    transactionDTime?: string | null;
                                    transactionSubtypeCode?: string | null;
                                    transactionTypeCode?: string | null;
                                    uniqueIdentifier?: string | null;
                                    usage?: { limitCode?: (...) | (...) | (...); userPersonId: string };
                                    valueDate?: string | null;
                                    virtualAccountId?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v4/accounts/{accountId}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { accountId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    accountClassCode?: string | null;
                                    accountId?: string | null;
                                    accountName?: string | null;
                                    accountNumbers?:
                                        | {
                                            accountId?: ...;
                                            accountNumber: ...;
                                            accountNumberId?: ...;
                                            accountNumberSubtype?: ...;
                                            countryCode?: ...;
                                            defaultCurrencyCode?: ...;
                                            externalSyncEnabled?: ...;
                                            financialInstitutionId?: ...;
                                            statusCode?: ...;
                                            tenantCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    accountTypeCode?: | "CURRENCY"
                                    | "INTERNAL"
                                    | "SAVING"
                                    | "SHADOW"
                                    | "VIRTUAL";
                                    accountTypeSetupCode?: string
                                    | null;
                                    activationDate?: string | null;
                                    balances?:
                                        | {
                                            accountId: ...;
                                            availableBalanceAmount?: ...;
                                            availableBalanceInDefaultCcy?: ...;
                                            balanceAmount?: ...;
                                            balanceId: ...;
                                            currencyCode: ...;
                                            defaultCurrencyCode?: ...;
                                            negativeBalanceStartDate?: ...;
                                            overdraftLimitAmount?: ...;
                                            reservedAmount?: ...;
                                            tenantCode?: ...;
                                        }[]
                                        | null;
                                    bic?: string
                                    | null;
                                    counterpartySectorCode?: string | null;
                                    customerGroupCode?: string | null;
                                    defaultCurrencyCode?: string | null;
                                    iban?: string | null;
                                    interestMethodAssignmentCode?: string | null;
                                    intraOrgCode?: string | null;
                                    jurisdictionCountryCode?: string | null;
                                    masterAccountId?: string | null;
                                    personId?: string | null;
                                    personName?: string | null;
                                    personTypeCode?: string | null;
                                    productCode?: string | null;
                                    residencyCode?: string | null;
                                    serviceProviderCode?: string | null;
                                    source?: { sourceName: string; sourceRef: string };
                                    statusCode?:
                                        | "ACTIVE"
                                        | "INACTIVE"
                                        | "CLOSED"
                                        | "CREATED"
                                        | "BLOCKED"
                                        | "WAITING_FOR_CLOSURE_DECISION";
                                    statusReasonCode?: string
                                    | null;
                                    taxResidencyCountryCode?: string | null;
                                    tenantCode?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v4/accounts/{accountId}/transactions/search": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { accountId: string };
                    query: {
                        amountFrom?: number;
                        amountTo?: number;
                        contractNumber?: string;
                        currencyCode?: string;
                        dateFrom: string;
                        dateTo: string;
                        dateType: "VALUE_DATE" | "POSTING_DATE";
                        directionCode?: string;
                        includeAccessRestricted?: boolean;
                        pageNumber?: number;
                        pageSize?: number;
                        referenceNumber?: string;
                        sourceName?: string;
                        sourceRef?: string;
                        transactionGroupCode?: string;
                        transactionSubtype?: string;
                        transactionType?: string;
                        uniqueIdentifier?: string;
                        virtualAccountId?: string;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    total?: number | null;
                                    values?:
                                        | {
                                            accountId?: ...;
                                            accountTransactionId?: ...;
                                            amount?: ...;
                                            contractSource?: ...;
                                            counterparty?: ...;
                                            createdDTime?: ...;
                                            currencyCode?: ...;
                                            details?: ...;
                                            directionCode?: ...;
                                            endToEndId?: ...;
                                            filingCode?: ...;
                                            groupId?: ...;
                                            initialBalanceAmount?: ...;
                                            labels?: ...;
                                            merchantInfo?: ...;
                                            metaInfo?: ...;
                                            paymentServiceProviderCode?: ...;
                                            postingDate?: ...;
                                            referenceNumber?: ...;
                                            reservationId?: ...;
                                            reversed?: ...;
                                            source?: ...;
                                            tenantCode?: ...;
                                            transactionDTime?: ...;
                                            transactionSubtypeCode?: ...;
                                            transactionTypeCode?: ...;
                                            uniqueIdentifier?: ...;
                                            usage?: ...;
                                            valueDate?: ...;
                                            virtualAccountId?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/v4/persons/{personId}/accounts": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            accountClassCode: | "PERSONAL_DDA"
                            | "BUSINESS_DDA"
                            | "CORPORATE_DDA"
                            | "FINANCIALINSTITUTION_OPS_DDA"
                            | "FI_CONCENTRATION_DDA";
                            accountName?: string
                            | null;
                            currencyCode: "USD";
                            masterAccountId: string;
                        };
                        "application/json": {
                            accountClassCode: | "PERSONAL_DDA"
                            | "BUSINESS_DDA"
                            | "CORPORATE_DDA"
                            | "FINANCIALINSTITUTION_OPS_DDA"
                            | "FI_CONCENTRATION_DDA";
                            accountName?: string
                            | null;
                            currencyCode: "USD";
                            masterAccountId: string;
                        };
                        "text/json": {
                            accountClassCode: | "PERSONAL_DDA"
                            | "BUSINESS_DDA"
                            | "CORPORATE_DDA"
                            | "FINANCIALINSTITUTION_OPS_DDA"
                            | "FI_CONCENTRATION_DDA";
                            accountName?: string
                            | null;
                            currencyCode: "USD";
                            masterAccountId: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    accountClassCode?: string | null;
                                    accountId?: string | null;
                                    accountName?: string | null;
                                    accountNumbers?:
                                        | {
                                            accountId?: ...;
                                            accountNumber: ...;
                                            accountNumberId?: ...;
                                            accountNumberSubtype?: ...;
                                            countryCode?: ...;
                                            defaultCurrencyCode?: ...;
                                            externalSyncEnabled?: ...;
                                            financialInstitutionId?: ...;
                                            statusCode?: ...;
                                            tenantCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    accountTypeCode?: | "CURRENCY"
                                    | "INTERNAL"
                                    | "SAVING"
                                    | "SHADOW"
                                    | "VIRTUAL";
                                    accountTypeSetupCode?: string
                                    | null;
                                    activationDate?: string | null;
                                    balances?:
                                        | {
                                            accountId: ...;
                                            availableBalanceAmount?: ...;
                                            availableBalanceInDefaultCcy?: ...;
                                            balanceAmount?: ...;
                                            balanceId: ...;
                                            currencyCode: ...;
                                            defaultCurrencyCode?: ...;
                                            negativeBalanceStartDate?: ...;
                                            overdraftLimitAmount?: ...;
                                            reservedAmount?: ...;
                                            tenantCode?: ...;
                                        }[]
                                        | null;
                                    bic?: string
                                    | null;
                                    counterpartySectorCode?: string | null;
                                    customerGroupCode?: string | null;
                                    defaultCurrencyCode?: string | null;
                                    iban?: string | null;
                                    interestMethodAssignmentCode?: string | null;
                                    intraOrgCode?: string | null;
                                    jurisdictionCountryCode?: string | null;
                                    masterAccountId?: string | null;
                                    personId?: string | null;
                                    personName?: string | null;
                                    personTypeCode?: string | null;
                                    productCode?: string | null;
                                    residencyCode?: string | null;
                                    serviceProviderCode?: string | null;
                                    source?: { sourceName: string; sourceRef: string };
                                    statusCode?:
                                        | "ACTIVE"
                                        | "INACTIVE"
                                        | "CLOSED"
                                        | "CREATED"
                                        | "BLOCKED"
                                        | "WAITING_FOR_CLOSURE_DECISION";
                                    statusReasonCode?: string
                                    | null;
                                    taxResidencyCountryCode?: string | null;
                                    tenantCode?: string | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/v5/persons/{personId}/accounts": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query: {
                        accountClassCodes?: string[];
                        accountTypeCodes?: (
                            "CURRENCY"
                            | "INTERNAL"
                            | "SAVING"
                            | "SHADOW"
                            | "VIRTUAL"
                        )[];
                        includeAccessRestricted?: boolean;
                        includeClosedAccounts?: boolean;
                        pageNumber: number;
                        pageSize: number;
                        statusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[];
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    endReached?: boolean
                                    | null;
                                    pageNumber?: number | null;
                                    pageSize?: number | null;
                                    sort?: { field?: ...; order?: ... }[] | null;
                                    total?: number | null;
                                    values?:
                                        | {
                                            accessRestricted?: ...;
                                            accountClassCode?: ...;
                                            accountId?: ...;
                                            accountName?: ...;
                                            accountNumbers?: ...;
                                            accountTypeCode?: ...;
                                            accountTypeSetupCode?: ...;
                                            activationDate?: ...;
                                            balances?: ...;
                                            bic?: ...;
                                            counterpartySectorCode?: ...;
                                            customerGroupCode?: ...;
                                            defaultCurrencyCode?: ...;
                                            iban?: ...;
                                            interestMethodAssignmentCode?: ...;
                                            intraOrgCode?: ...;
                                            jurisdictionCountryCode?: ...;
                                            masterAccountId?: ...;
                                            personId?: ...;
                                            personName?: ...;
                                            personTypeCode?: ...;
                                            productCode?: ...;
                                            residencyCode?: ...;
                                            serviceProviderCode?: ...;
                                            source?: ...;
                                            statusCode?: ...;
                                            statusReasonCode?: ...;
                                            taxResidencyCountryCode?: ...;
                                            tenantCode?: ...;
                                        }[]
                                        | null;
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/accounts/{accountId}/{chain}/usdc-address": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path: { accountId: string; chain: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                address?: string
                                | null;
                                chain?: string | null;
                                createDate?: string | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/accounts/{accountId}/assign-vrn": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path: { accountId: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": { content?: undefined; headers: { [name: string]: unknown } };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[] | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/accounts/usdc-recipient": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/*+json": {
                            address: string;
                            bns: string;
                            chain?: string
                            | null;
                            email: string;
                            nickname: string;
                        };
                        "application/json": {
                            address: string;
                            bns: string;
                            chain?: string
                            | null;
                            email: string;
                            nickname: string;
                        };
                        "text/json": {
                            address: string;
                            bns: string;
                            chain?: string
                            | null;
                            email: string;
                            nickname: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: { "application/json": { id: string } };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/payments/{paymentId}/files": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { paymentId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            externalId?: string
                            | null;
                            fileBytes: string;
                            fileName: string;
                            fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                        };
                        "application/json": {
                            externalId?: string
                            | null;
                            fileBytes: string;
                            fileName: string;
                            fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                        };
                        "text/json": {
                            externalId?: string
                            | null;
                            fileBytes: string;
                            fileName: string;
                            fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    addedDate?: string
                                    | null;
                                    contractSource?: {
                                        contractNumber?: (...) | (...) | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    deleted?: boolean
                                    | null;
                                    fileId?: string | null;
                                    fileName?: string | null;
                                    fileTypeCode?: string | null;
                                    parameters?: { code?: ...; value?: ... }[] | null;
                                    source?: { sourceName: string; sourceRef: string };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/persons/{personId}/custom-fields/value": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": { fieldId: string; fieldValue: string };
                        "application/json": { fieldId: string; fieldValue: string };
                        "text/json": { fieldId: string; fieldValue: string };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/zv1/persons/{personId}/custom-fields/value/batch": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            fieldValues: { fieldId: string; fieldValue: string }[];
                        };
                        "application/json": {
                            fieldValues: { fieldId: string; fieldValue: string }[];
                        };
                        "text/json": { fieldValues: { fieldId: string; fieldValue: string }[] };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: unknown;
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/zv1/persons/{personId}/files": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            files: {
                                externalId?: string
                                | null;
                                fileBytes: string;
                                fileName: string;
                                fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                                fileTypeCode:
                                    | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "BIOMETRIC_REPORT"
                                    | "PROOF_OF_ADDRESS"
                                    | "FATCA"
                                    | "SOURCE_OF_FUNDS"
                                    | "EMPLOYMENT_VERIFICATION_LETTER"
                                    | "CRYPTO_WALLET_ADDRESS"
                                    | "DOCUMENT_COPY"
                                    | "ARTICLES_OF_ASSOCIATION"
                                    | "AML_CFT_SANCTIONS_IND_AUDIT"
                                    | "AML_CTF_SANCTIONS_POLICY"
                                    | "AML_CTF_TRAINING_PROGRAM"
                                    | "AUTHORIZED_SIGNATURE_FORM"
                                    | "BANKING_LICENSE"
                                    | "BANKING_REFERENCE"
                                    | "CERTIF_INCORPORATION_REG"
                                    | "COMPANY_FISCAL_REG_CERTIF"
                                    | "COMPLIANCE_DEPARTMENT"
                                    | "COMPLIANCE_OFFICER_RESUME"
                                    | "CORPORATE_RESOLUTION"
                                    | "FI_CORPORATE_STAMP"
                                    | "FI_LICENSE"
                                    | "FINANCIAL_STATEMENTS"
                                    | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                    | "GOOD_STANDING_CERTIFICATION"
                                    | "GOV_COMPANY_REG_NUMBER"
                                    | "MEM_OF_ASSOCIATION"
                                    | "ML_TF_RISK_ASSESSMENT"
                                    | "SHARE_CERTIFICATE"
                                    | "SOURCE_OF_FUNDS_CERTIFICATION"
                                    | "TAX_ID_NUMBER"
                                    | "RFI"
                                    | "CORPORATE_RECORDS"
                                    | "WOLFSBERG_GCBDDQ"
                                    | "KYB_REVIEW"
                                    | "EDD_CONCENTRATION_FORM";
                            }[];
                        };
                        "application/json": {
                            files: {
                                externalId?: string
                                | null;
                                fileBytes: string;
                                fileName: string;
                                fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                                fileTypeCode:
                                    | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "BIOMETRIC_REPORT"
                                    | "PROOF_OF_ADDRESS"
                                    | "FATCA"
                                    | "SOURCE_OF_FUNDS"
                                    | "EMPLOYMENT_VERIFICATION_LETTER"
                                    | "CRYPTO_WALLET_ADDRESS"
                                    | "DOCUMENT_COPY"
                                    | "ARTICLES_OF_ASSOCIATION"
                                    | "AML_CFT_SANCTIONS_IND_AUDIT"
                                    | "AML_CTF_SANCTIONS_POLICY"
                                    | "AML_CTF_TRAINING_PROGRAM"
                                    | "AUTHORIZED_SIGNATURE_FORM"
                                    | "BANKING_LICENSE"
                                    | "BANKING_REFERENCE"
                                    | "CERTIF_INCORPORATION_REG"
                                    | "COMPANY_FISCAL_REG_CERTIF"
                                    | "COMPLIANCE_DEPARTMENT"
                                    | "COMPLIANCE_OFFICER_RESUME"
                                    | "CORPORATE_RESOLUTION"
                                    | "FI_CORPORATE_STAMP"
                                    | "FI_LICENSE"
                                    | "FINANCIAL_STATEMENTS"
                                    | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                    | "GOOD_STANDING_CERTIFICATION"
                                    | "GOV_COMPANY_REG_NUMBER"
                                    | "MEM_OF_ASSOCIATION"
                                    | "ML_TF_RISK_ASSESSMENT"
                                    | "SHARE_CERTIFICATE"
                                    | "SOURCE_OF_FUNDS_CERTIFICATION"
                                    | "TAX_ID_NUMBER"
                                    | "RFI"
                                    | "CORPORATE_RECORDS"
                                    | "WOLFSBERG_GCBDDQ"
                                    | "KYB_REVIEW"
                                    | "EDD_CONCENTRATION_FORM";
                            }[];
                        };
                        "text/json": {
                            files: {
                                externalId?: string
                                | null;
                                fileBytes: string;
                                fileName: string;
                                fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                                fileTypeCode:
                                    | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "BIOMETRIC_REPORT"
                                    | "PROOF_OF_ADDRESS"
                                    | "FATCA"
                                    | "SOURCE_OF_FUNDS"
                                    | "EMPLOYMENT_VERIFICATION_LETTER"
                                    | "CRYPTO_WALLET_ADDRESS"
                                    | "DOCUMENT_COPY"
                                    | "ARTICLES_OF_ASSOCIATION"
                                    | "AML_CFT_SANCTIONS_IND_AUDIT"
                                    | "AML_CTF_SANCTIONS_POLICY"
                                    | "AML_CTF_TRAINING_PROGRAM"
                                    | "AUTHORIZED_SIGNATURE_FORM"
                                    | "BANKING_LICENSE"
                                    | "BANKING_REFERENCE"
                                    | "CERTIF_INCORPORATION_REG"
                                    | "COMPANY_FISCAL_REG_CERTIF"
                                    | "COMPLIANCE_DEPARTMENT"
                                    | "COMPLIANCE_OFFICER_RESUME"
                                    | "CORPORATE_RESOLUTION"
                                    | "FI_CORPORATE_STAMP"
                                    | "FI_LICENSE"
                                    | "FINANCIAL_STATEMENTS"
                                    | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                    | "GOOD_STANDING_CERTIFICATION"
                                    | "GOV_COMPANY_REG_NUMBER"
                                    | "MEM_OF_ASSOCIATION"
                                    | "ML_TF_RISK_ASSESSMENT"
                                    | "SHARE_CERTIFICATE"
                                    | "SOURCE_OF_FUNDS_CERTIFICATION"
                                    | "TAX_ID_NUMBER"
                                    | "RFI"
                                    | "CORPORATE_RECORDS"
                                    | "WOLFSBERG_GCBDDQ"
                                    | "KYB_REVIEW"
                                    | "EDD_CONCENTRATION_FORM";
                            }[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                files?: {
                                    externalId?: string | null;
                                    fileBytes?: string | null;
                                    fileId?: string;
                                    fileName?: string;
                                    fileTypeCode?:
                                        | "PASSPORT"
                                        | "DRIVER_LICENCE"
                                        | "ID_CARD"
                                        | "BIOMETRIC_REPORT"
                                        | "PROOF_OF_ADDRESS"
                                        | "FATCA"
                                        | "SOURCE_OF_FUNDS"
                                        | "EMPLOYMENT_VERIFICATION_LETTER"
                                        | "CRYPTO_WALLET_ADDRESS"
                                        | "DOCUMENT_COPY"
                                        | "ARTICLES_OF_ASSOCIATION"
                                        | "AML_CFT_SANCTIONS_IND_AUDIT"
                                        | "AML_CTF_SANCTIONS_POLICY"
                                        | "AML_CTF_TRAINING_PROGRAM"
                                        | "AUTHORIZED_SIGNATURE_FORM"
                                        | "BANKING_LICENSE"
                                        | "BANKING_REFERENCE"
                                        | "CERTIF_INCORPORATION_REG"
                                        | "COMPANY_FISCAL_REG_CERTIF"
                                        | "COMPLIANCE_DEPARTMENT"
                                        | "COMPLIANCE_OFFICER_RESUME"
                                        | "CORPORATE_RESOLUTION"
                                        | "FI_CORPORATE_STAMP"
                                        | "FI_LICENSE"
                                        | "FINANCIAL_STATEMENTS"
                                        | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                        | "GOOD_STANDING_CERTIFICATION"
                                        | "GOV_COMPANY_REG_NUMBER"
                                        | "MEM_OF_ASSOCIATION"
                                        | "ML_TF_RISK_ASSESSMENT"
                                        | "SHARE_CERTIFICATE"
                                        | "SOURCE_OF_FUNDS_CERTIFICATION"
                                        | "TAX_ID_NUMBER"
                                        | "RFI"
                                        | "CORPORATE_RECORDS"
                                        | "WOLFSBERG_GCBDDQ"
                                        | "KYB_REVIEW"
                                        | "EDD_CONCENTRATION_FORM";
                                }[];
                                validationErrors?: | {
                                    errors?: (...)[]
                                    | null;
                                    field?: string | null;
                                }[]
                                | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/zv1/persons/{personId}/identificationNumbers": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            expiryDate: string;
                            idCountryCode: string;
                            idNumber: string;
                            idTypeCode: "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD";
                            issuingDate?: string | null;
                        };
                        "application/json": {
                            expiryDate: string;
                            idCountryCode: string;
                            idNumber: string;
                            idTypeCode: "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD";
                            issuingDate?: string | null;
                        };
                        "text/json": {
                            expiryDate: string;
                            idCountryCode: string;
                            idNumber: string;
                            idTypeCode: "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD";
                            issuingDate?: string | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    docuId?: string
                                    | null;
                                    documentTypeCode?: string | null;
                                    expiryDate?: string | null;
                                    issuingCountry?: string | null;
                                    number?: string | null;
                                    personId?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/api/zv1/persons/{personId}/taxNumbers": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                    path: { personId: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            primary: boolean;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                            | "TAX_CODE"
                            | "SSN";
                        };
                        "application/json": {
                            primary: boolean;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                            | "TAX_CODE"
                            | "SSN";
                        };
                        "text/json": {
                            primary: boolean;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                            | "TAX_CODE"
                            | "SSN";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    personId?: string
                                    | null;
                                    primary?: boolean | null;
                                    taxCountryCode?: string | null;
                                    taxNumber?: string | null;
                                    taxNumberId?: string | null;
                                    taxNumberTypeCode?: string | null;
                                    validityRange?: {
                                        endTime?: (...) | (...) | (...);
                                        startTime?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/persons/legal": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            addresses?: | {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                stateRegion?: string
                                | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[]
                            | null;
                            counterpartySectorCode?: string
                            | null;
                            identificationNumbers?:
                                | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                                | null;
                            name?: string | null;
                            registrationDate?: string | null;
                            taxNumbers?:
                                | {
                                    primary?: boolean
                                    | null;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode?:
                                        | "TAX_IDENTIFICATION_NUMBER"
                                        | "VAT_NUMBER"
                                        | "NATIONAL_INSURANCE_NUMBER";
                                }[]
                                | null;
                            webAddress?: string
                            | null;
                        };
                        "application/json": {
                            addresses?: | {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                stateRegion?: string
                                | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[]
                            | null;
                            counterpartySectorCode?: string
                            | null;
                            identificationNumbers?:
                                | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                                | null;
                            name?: string | null;
                            registrationDate?: string | null;
                            taxNumbers?:
                                | {
                                    primary?: boolean
                                    | null;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode?:
                                        | "TAX_IDENTIFICATION_NUMBER"
                                        | "VAT_NUMBER"
                                        | "NATIONAL_INSURANCE_NUMBER";
                                }[]
                                | null;
                            webAddress?: string
                            | null;
                        };
                        "text/json": {
                            addresses?: | {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                stateRegion?: string
                                | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[]
                            | null;
                            counterpartySectorCode?: string
                            | null;
                            identificationNumbers?:
                                | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                                | null;
                            name?: string | null;
                            registrationDate?: string | null;
                            taxNumbers?:
                                | {
                                    primary?: boolean
                                    | null;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode?:
                                        | "TAX_IDENTIFICATION_NUMBER"
                                        | "VAT_NUMBER"
                                        | "NATIONAL_INSURANCE_NUMBER";
                                }[]
                                | null;
                            webAddress?: string
                            | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    additionalContacts?:
                                        | {
                                            additionalContactId?: ...;
                                            contactTypeCode?: ...;
                                            description?: ...;
                                            email?: ...;
                                            personId?: ...;
                                            phoneCountryCode?: ...;
                                            phoneNumber?: ...;
                                            preferredMethodOfContact?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    additionalInfo?: {
                                        birthDate?: (...)
                                        | (...)
                                        | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    addresses?: | {
                                        addressId?: ...;
                                        addressTypeCode?: ...;
                                        apartmentNumber?: ...;
                                        buildingName?: ...;
                                        buildingNumber?: ...;
                                        cityCounty?: ...;
                                        countryCode?: ...;
                                        department?: ...;
                                        district?: ...;
                                        floor?: ...;
                                        moveInDate?: ...;
                                        personId?: ...;
                                        postBox?: ...;
                                        stateRegion?: ...;
                                        street1?: ...;
                                        street2?: ...;
                                        streetName?: ...;
                                        structured?: ...;
                                        subDepartment?: ...;
                                        townLocationName?: ...;
                                        validityRange?: ...;
                                        zip?: ...;
                                    }[]
                                    | null;
                                    creationDate?: string
                                    | null;
                                    documents?:
                                        | {
                                            docuId?: ...;
                                            documentTypeCode?: ...;
                                            expiryDate?: ...;
                                            issuingCountry?: ...;
                                            number?: ...;
                                            personId?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    forgotten?: boolean
                                    | null;
                                    fullName?: string | null;
                                    home?: {
                                        buildingTypeCode?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                    };
                                    identificationNumbers?: | {
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        idNumberId?: ...;
                                        personId?: ...;
                                        primary?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    legalForm?: string
                                    | null;
                                    mainPersonId?: string | null;
                                    personalInfo?: {
                                        dependantPersons?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                    };
                                    personGroupCodes?: | {
                                        personGroupCode: ...;
                                        personGroupId?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    personId?: string
                                    | null;
                                    relationships?:
                                        | {
                                            additionalData?: ...;
                                            beneficiary?: ...;
                                            parent?: ...;
                                            parentPersonId?: ...;
                                            percentageOfShares?: ...;
                                            percentageOfSignature?: ...;
                                            person?: ...;
                                            personId?: ...;
                                            personRelationshipId?: ...;
                                            relationTypeCode?: ...;
                                            representingRange?: ...;
                                            role?: ...;
                                            statusCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    source?: {
                                        sourceLink?: (...)
                                        | (...)
                                        | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    statusCode?: string
                                    | null;
                                    taxNumbers?:
                                        | {
                                            personId?: ...;
                                            primary?: ...;
                                            taxCountryCode?: ...;
                                            taxNumber?: ...;
                                            taxNumberId?: ...;
                                            taxNumberTypeCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    tenantCode?: string
                                    | null;
                                    work?: {
                                        activityCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/api/zv1/persons/private": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "x-request-id": string; "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/*+json": {
                            addresses: {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                moveInDate?: string
                                | null;
                                stateRegion?: string | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[];
                            birthDate: string;
                            countryOfBirth: string;
                            email?: string
                            | null;
                            givenName: string;
                            identificationNumbers: {
                                expiryDate: string;
                                idCountryCode: string;
                                idNumber: string;
                                idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                                issuingDate?: string | null;
                                primary?: boolean;
                            }[];
                            middleName?: string
                            | null;
                            nationality: string;
                            pep: boolean;
                            pepExplanation?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            residencyCountryCode?: string | null;
                            sex: "M" | "F" | "O";
                            surname: string;
                            taxNumbers?:
                                | {
                                    primary: boolean;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                                    | "TAX_CODE"
                                    | "SSN";
                                }[]
                                | null;
                            usResident?: boolean
                            | null;
                        };
                        "application/json": {
                            addresses: {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                moveInDate?: string
                                | null;
                                stateRegion?: string | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[];
                            birthDate: string;
                            countryOfBirth: string;
                            email?: string
                            | null;
                            givenName: string;
                            identificationNumbers: {
                                expiryDate: string;
                                idCountryCode: string;
                                idNumber: string;
                                idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                                issuingDate?: string | null;
                                primary?: boolean;
                            }[];
                            middleName?: string
                            | null;
                            nationality: string;
                            pep: boolean;
                            pepExplanation?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            residencyCountryCode?: string | null;
                            sex: "M" | "F" | "O";
                            surname: string;
                            taxNumbers?:
                                | {
                                    primary: boolean;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                                    | "TAX_CODE"
                                    | "SSN";
                                }[]
                                | null;
                            usResident?: boolean
                            | null;
                        };
                        "text/json": {
                            addresses: {
                                addressTypeCode: | "R"
                                | "C"
                                | "B"
                                | "D"
                                | "BILLING"
                                | "HQ_LOCATION"
                                | "PLACE_OF_BUSINESS"
                                | "SUBSIDIARY";
                                cityCounty: string;
                                countryCode: string;
                                moveInDate?: string
                                | null;
                                stateRegion?: string | null;
                                street1: string;
                                street2?: string | null;
                                zip: string;
                            }[];
                            birthDate: string;
                            countryOfBirth: string;
                            email?: string
                            | null;
                            givenName: string;
                            identificationNumbers: {
                                expiryDate: string;
                                idCountryCode: string;
                                idNumber: string;
                                idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                                issuingDate?: string | null;
                                primary?: boolean;
                            }[];
                            middleName?: string
                            | null;
                            nationality: string;
                            pep: boolean;
                            pepExplanation?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            residencyCountryCode?: string | null;
                            sex: "M" | "F" | "O";
                            surname: string;
                            taxNumbers?:
                                | {
                                    primary: boolean;
                                    taxCountryCode: string;
                                    taxNumber: string;
                                    taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                                    | "TAX_CODE"
                                    | "SSN";
                                }[]
                                | null;
                            usResident?: boolean
                            | null;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data?: {
                                    accessRestricted?: boolean
                                    | null;
                                    additionalContacts?:
                                        | {
                                            additionalContactId?: ...;
                                            contactTypeCode?: ...;
                                            description?: ...;
                                            email?: ...;
                                            personId?: ...;
                                            phoneCountryCode?: ...;
                                            phoneNumber?: ...;
                                            preferredMethodOfContact?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    additionalInfo?: {
                                        birthDate?: (...)
                                        | (...)
                                        | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        businessModelDescription?: (...) | (...) | (...);
                                        counterpartySectorCode?: (...) | (...) | (...);
                                        countryOfBirth?: (...) | (...) | (...);
                                        customerTypeCode?: (...) | (...) | (...);
                                        deathDate?: (...) | (...) | (...);
                                        dependantPersons?: (...) | (...) | (...);
                                        educationCode?: (...) | (...) | (...);
                                        inactivationDate?: (...) | (...) | (...);
                                        intraOrgCode?: (...) | (...) | (...);
                                        language?: (...) | (...) | (...);
                                        liquidationDate?: (...) | (...) | (...);
                                        mainPersonId?: (...) | (...) | (...);
                                        maritalStatusCode?: (...) | (...) | (...);
                                        pep?: (...) | (...) | (...) | (...);
                                        pepExplanation?: (...) | (...) | (...);
                                        placeOfBirth?: (...) | (...) | (...);
                                        registrationDate?: (...) | (...) | (...);
                                        statusCodeReason?: (...) | (...) | (...);
                                        taxResidencyCountry?: (...) | (...) | (...);
                                        tradingName?: (...) | (...) | (...);
                                        usResident?: (...) | (...) | (...) | (...);
                                        webAddress?: (...) | (...) | (...);
                                    };
                                    addresses?: | {
                                        addressId?: ...;
                                        addressTypeCode?: ...;
                                        apartmentNumber?: ...;
                                        buildingName?: ...;
                                        buildingNumber?: ...;
                                        cityCounty?: ...;
                                        countryCode?: ...;
                                        department?: ...;
                                        district?: ...;
                                        floor?: ...;
                                        moveInDate?: ...;
                                        personId?: ...;
                                        postBox?: ...;
                                        stateRegion?: ...;
                                        street1?: ...;
                                        street2?: ...;
                                        streetName?: ...;
                                        structured?: ...;
                                        subDepartment?: ...;
                                        townLocationName?: ...;
                                        validityRange?: ...;
                                        zip?: ...;
                                    }[]
                                    | null;
                                    creationDate?: string
                                    | null;
                                    documents?:
                                        | {
                                            docuId?: ...;
                                            documentTypeCode?: ...;
                                            expiryDate?: ...;
                                            issuingCountry?: ...;
                                            number?: ...;
                                            personId?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    forgotten?: boolean
                                    | null;
                                    fullName?: string | null;
                                    home?: {
                                        buildingTypeCode?: (...) | (...) | (...);
                                        housingTypeCode?: (...) | (...) | (...);
                                    };
                                    identificationNumbers?: | {
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        idNumberId?: ...;
                                        personId?: ...;
                                        primary?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    legalForm?: string
                                    | null;
                                    mainPersonId?: string | null;
                                    personalInfo?: {
                                        dependantPersons?: (...) | (...) | (...);
                                        email?: (...) | (...) | (...);
                                        givenName?: (...) | (...) | (...);
                                        legalForm?: (...) | (...) | (...);
                                        middleName?: (...) | (...) | (...);
                                        name?: (...) | (...) | (...);
                                        nationality?: (...) | (...) | (...);
                                        personTypeCode?: (...) | (...) | (...);
                                        phoneCountryCode?: (...) | (...) | (...);
                                        phoneNumber?: (...) | (...) | (...);
                                        residencyCountryCode?: (...) | (...) | (...);
                                        sex?: (...) | (...) | (...);
                                        surname?: (...) | (...) | (...);
                                    };
                                    personGroupCodes?: | {
                                        personGroupCode: ...;
                                        personGroupId?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                    personId?: string
                                    | null;
                                    relationships?:
                                        | {
                                            additionalData?: ...;
                                            beneficiary?: ...;
                                            parent?: ...;
                                            parentPersonId?: ...;
                                            percentageOfShares?: ...;
                                            percentageOfSignature?: ...;
                                            person?: ...;
                                            personId?: ...;
                                            personRelationshipId?: ...;
                                            relationTypeCode?: ...;
                                            representingRange?: ...;
                                            role?: ...;
                                            statusCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    source?: {
                                        sourceLink?: (...)
                                        | (...)
                                        | (...);
                                        sourceName: string;
                                        sourceRef: string;
                                    };
                                    statusCode?: string
                                    | null;
                                    taxNumbers?:
                                        | {
                                            personId?: ...;
                                            primary?: ...;
                                            taxCountryCode?: ...;
                                            taxNumber?: ...;
                                            taxNumberId?: ...;
                                            taxNumberTypeCode?: ...;
                                            validityRange?: ...;
                                        }[]
                                        | null;
                                    tenantCode?: string
                                    | null;
                                    work?: {
                                        activityCode?: (...) | (...) | (...);
                                        businessAreaCodes?: (...) | (...) | (...);
                                        employmentTimeCode?: (...) | (...) | (...);
                                        fixedEmploymentLength?: (...) | (...) | (...);
                                    };
                                };
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/login/oauth2/v2.0/token": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: { "x-tenant-id"?: string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/x-www-form-urlencoded": {
                            client_id?: string;
                            client_secret?: string;
                            grant_type?: string;
                            scope?: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                access_token?: string;
                                expires_in?: number;
                                ext_expires_in?: number;
                                token_type?: string
                                | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                correlation_id?: string
                                | null;
                                error?: string | null;
                                error_codes?: number[] | null;
                                error_description?: string | null;
                                error_uri?: string | null;
                                timestamp?: string | null;
                                trace_id?: string | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                errors?: string[]
                                | null;
                                validationErrors?:
                                    | { errors?: (...)[]
                                    | null; field?: string | null }[]
                                    | null;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
    }
    Index
    / /api/v1/accounts/{accountId}/balances /api/v1/accounts/{accountId}/balances-history /api/v1/accounts/{accountId}/closure/start /api/v1/accounts/{childAccountId}/parent-accounts /api/v1/accounts/{parentAccountId}/child-accounts /api/v1/persons/{personId} /api/v1/persons/{personId}/activate /api/v1/persons/{personId}/additional /api/v1/persons/{personId}/addresses /api/v1/persons/{personId}/personal /api/v1/persons/{personId}/relations /api/v1/persons/{personId}/relations/closing/{personRelationshipId} /api/v1/persons/{personId}/risks /api/v1/persons/custom-fields/value /api/v1/persons/files /api/v1/persons/search /api/v2/payments/{paymentId} /api/v2/payments/{paymentId}/return /api/v2/persons /api/v2/persons/{personId}/addresses /api/v2/persons/{personId}/addresses/{addressId} /api/v2/persons/{personId}/relations /api/v2/persons/{personId}/relations/{personRelationshipId} /api/v2/persons/custom-fields/value /api/v2/persons/search /api/v3/accounts/{accountId}/payments /api/v3/accounts/by-account-number /api/v3/payments/{paymentId}/cancel /api/v3/payments/{paymentId}/confirm /api/v3/payments/initialise /api/v3/persons/{personId} /api/v3/transactions/{transactionId} /api/v4/accounts/{accountId} /api/v4/accounts/{accountId}/transactions/search /api/v4/persons/{personId}/accounts /api/v5/persons/{personId}/accounts /api/zv1/accounts/{accountId}/{chain}/usdc-address /api/zv1/accounts/{accountId}/assign-vrn /api/zv1/accounts/usdc-recipient /api/zv1/payments/{paymentId}/files /api/zv1/persons/{personId}/custom-fields/value /api/zv1/persons/{personId}/custom-fields/value/batch /api/zv1/persons/{personId}/files /api/zv1/persons/{personId}/identificationNumbers /api/zv1/persons/{personId}/taxNumbers /api/zv1/persons/legal /api/zv1/persons/private /login/oauth2/v2.0/token
    "/": {
        delete?: undefined;
        get?: undefined;
        head: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": { content?: undefined; headers: { [name: string]: unknown } };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[] | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • head: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": { content?: undefined; headers: { [name: string]: unknown } };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[] | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      HEAD

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: { content?: undefined; headers: { [name: string]: unknown } }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/accounts/{accountId}/balances": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { accountId: string };
                query?: { currencyCode?: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: | {
                                accountId: string;
                                availableBalanceAmount?: number
                                | null;
                                availableBalanceInDefaultCcy?: number | null;
                                balanceAmount?: number | null;
                                balanceId: string;
                                currencyCode: string;
                                defaultCurrencyCode: string;
                                negativeBalanceStartDate?: string | null;
                                overdraftLimitAmount?: number | null;
                                reservedAmount?: number | null;
                                tenantCode?: string | null;
                            }[]
                            | null;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { accountId: string };
              query?: { currencyCode?: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: | {
                              accountId: string;
                              availableBalanceAmount?: number
                              | null;
                              availableBalanceInDefaultCcy?: number | null;
                              balanceAmount?: number | null;
                              balanceId: string;
                              currencyCode: string;
                              defaultCurrencyCode: string;
                              negativeBalanceStartDate?: string | null;
                              overdraftLimitAmount?: number | null;
                              reservedAmount?: number | null;
                              tenantCode?: string | null;
                          }[]
                          | null;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find master account balances by master account ID

      Finds master account balances information in the requested currency

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { accountId: string };
            query?: { currencyCode?: string };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
        • Optionalquery?: { currencyCode?: string }
          • OptionalcurrencyCode?: string

            Currency code

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?:
                            | {
                                accountId: string;
                                availableBalanceAmount?: number
                                | null;
                                availableBalanceInDefaultCcy?: number | null;
                                balanceAmount?: number | null;
                                balanceId: string;
                                currencyCode: string;
                                defaultCurrencyCode: string;
                                negativeBalanceStartDate?: string | null;
                                overdraftLimitAmount?: number | null;
                                reservedAmount?: number | null;
                                tenantCode?: string | null;
                            }[]
                            | null;
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?:
                          | {
                              accountId: string;
                              availableBalanceAmount?: number
                              | null;
                              availableBalanceInDefaultCcy?: number | null;
                              balanceAmount?: number | null;
                              balanceId: string;
                              currencyCode: string;
                              defaultCurrencyCode: string;
                              negativeBalanceStartDate?: string | null;
                              overdraftLimitAmount?: number | null;
                              reservedAmount?: number | null;
                              tenantCode?: string | null;
                          }[]
                          | null;
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/accounts/{accountId}/balances-history": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { accountId: string };
                query: { currencyCode?: string; validOn: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: | {
                                accountId?: string
                                | null;
                                balanceHistoryId?: string | null;
                                money?: { amount?: ...; currencyCode: ... };
                                tenantCode?: string | null;
                                validityRange?: { endDate?: ...; startDate?: ... };
                            }[]
                            | null;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { accountId: string };
              query: { currencyCode?: string; validOn: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: | {
                              accountId?: string
                              | null;
                              balanceHistoryId?: string | null;
                              money?: { amount?: ...; currencyCode: ... };
                              tenantCode?: string | null;
                              validityRange?: { endDate?: ...; startDate?: ... };
                          }[]
                          | null;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find master account balance histories by master account ID

      Fetches master account balance history by posting date for a specified master account. Note: Posting date is the date when the transaction was posted/created in the system

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { accountId: string };
            query: { currencyCode?: string; validOn: string };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
        • query: { currencyCode?: string; validOn: string }
          • OptionalcurrencyCode?: string

            Currency code

          • validOn: string

            Format: YYYY-MM-DD. Valid on

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?:
                            | {
                                accountId?: string
                                | null;
                                balanceHistoryId?: string | null;
                                money?: { amount?: ...; currencyCode: ... };
                                tenantCode?: string | null;
                                validityRange?: { endDate?: ...; startDate?: ... };
                            }[]
                            | null;
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?:
                          | {
                              accountId?: string
                              | null;
                              balanceHistoryId?: string | null;
                              money?: { amount?: ...; currencyCode: ... };
                              tenantCode?: string | null;
                              validityRange?: { endDate?: ...; startDate?: ... };
                          }[]
                          | null;
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/accounts/{accountId}/closure/start": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path: { accountId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        comment?: string
                        | null;
                        statusReasonCode?: "CUSTOMER_DECISION";
                    };
                    "application/json": {
                        comment?: string
                        | null;
                        statusReasonCode?: "CUSTOMER_DECISION";
                    };
                    "text/json": {
                        comment?: string
                        | null;
                        statusReasonCode?: "CUSTOMER_DECISION";
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path: { accountId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      comment?: string
                      | null;
                      statusReasonCode?: "CUSTOMER_DECISION";
                  };
                  "application/json": {
                      comment?: string
                      | null;
                      statusReasonCode?: "CUSTOMER_DECISION";
                  };
                  "text/json": {
                      comment?: string
                      | null;
                      statusReasonCode?: "CUSTOMER_DECISION";
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Close account

      Closes an account. Note: once the account is closed, it cannot be reopened

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path: { accountId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    comment?: string | null;
                    statusReasonCode?: "CUSTOMER_DECISION";
                };
                "application/json": {
                    comment?: string
                    | null;
                    statusReasonCode?: "CUSTOMER_DECISION";
                };
                "text/json": {
                    comment?: string
                    | null;
                    statusReasonCode?: "CUSTOMER_DECISION";
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/accounts/{childAccountId}/parent-accounts": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { childAccountId: string };
                query: { pageNumber: number; pageSize: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                total?: number | null;
                                values?:
                                    | {
                                        accessRestricted?: ...;
                                        accountClassCode?: ...;
                                        accountId?: ...;
                                        accountName?: ...;
                                        accountNumbers?: ...;
                                        accountRelationshipId?: ...;
                                        accountTypeCode?: ...;
                                        accountTypeSetupCode?: ...;
                                        activationDate?: ...;
                                        bic?: ...;
                                        counterpartySectorCode?: ...;
                                        customerGroupCode?: ...;
                                        defaultCurrencyCode?: ...;
                                        iban?: ...;
                                        interestMethodAssignmentCode?: ...;
                                        intraOrgCode?: ...;
                                        jurisdictionCountryCode?: ...;
                                        personId?: ...;
                                        personName?: ...;
                                        personTypeCode?: ...;
                                        productCode?: ...;
                                        relationshipType?: ...;
                                        relationshipValidityRange?: ...;
                                        residencyCode?: ...;
                                        serviceProviderCode?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusReasonCode?: ...;
                                        taxResidencyCountryCode?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { childAccountId: string };
              query: { pageNumber: number; pageSize: number };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              total?: number | null;
                              values?:
                                  | {
                                      accessRestricted?: ...;
                                      accountClassCode?: ...;
                                      accountId?: ...;
                                      accountName?: ...;
                                      accountNumbers?: ...;
                                      accountRelationshipId?: ...;
                                      accountTypeCode?: ...;
                                      accountTypeSetupCode?: ...;
                                      activationDate?: ...;
                                      bic?: ...;
                                      counterpartySectorCode?: ...;
                                      customerGroupCode?: ...;
                                      defaultCurrencyCode?: ...;
                                      iban?: ...;
                                      interestMethodAssignmentCode?: ...;
                                      intraOrgCode?: ...;
                                      jurisdictionCountryCode?: ...;
                                      personId?: ...;
                                      personName?: ...;
                                      personTypeCode?: ...;
                                      productCode?: ...;
                                      relationshipType?: ...;
                                      relationshipValidityRange?: ...;
                                      residencyCode?: ...;
                                      serviceProviderCode?: ...;
                                      source?: ...;
                                      statusCode?: ...;
                                      statusReasonCode?: ...;
                                      taxResidencyCountryCode?: ...;
                                      tenantCode?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find master account by virtual child account ID

      Fetches parent account by virtual child account ID. Includes information about the master-child relationship.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { childAccountId: string };
            query: { pageNumber: number; pageSize: number };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { childAccountId: string }
        • query: { pageNumber: number; pageSize: number }
          • pageNumber: number

            Format - int32. Page number

          • pageSize: number

            Format - int32. Page size

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            total?: number | null;
                            values?:
                                | {
                                    accessRestricted?: ...;
                                    accountClassCode?: ...;
                                    accountId?: ...;
                                    accountName?: ...;
                                    accountNumbers?: ...;
                                    accountRelationshipId?: ...;
                                    accountTypeCode?: ...;
                                    accountTypeSetupCode?: ...;
                                    activationDate?: ...;
                                    bic?: ...;
                                    counterpartySectorCode?: ...;
                                    customerGroupCode?: ...;
                                    defaultCurrencyCode?: ...;
                                    iban?: ...;
                                    interestMethodAssignmentCode?: ...;
                                    intraOrgCode?: ...;
                                    jurisdictionCountryCode?: ...;
                                    personId?: ...;
                                    personName?: ...;
                                    personTypeCode?: ...;
                                    productCode?: ...;
                                    relationshipType?: ...;
                                    relationshipValidityRange?: ...;
                                    residencyCode?: ...;
                                    serviceProviderCode?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusReasonCode?: ...;
                                    taxResidencyCountryCode?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          total?: number | null;
                          values?:
                              | {
                                  accessRestricted?: ...;
                                  accountClassCode?: ...;
                                  accountId?: ...;
                                  accountName?: ...;
                                  accountNumbers?: ...;
                                  accountRelationshipId?: ...;
                                  accountTypeCode?: ...;
                                  accountTypeSetupCode?: ...;
                                  activationDate?: ...;
                                  bic?: ...;
                                  counterpartySectorCode?: ...;
                                  customerGroupCode?: ...;
                                  defaultCurrencyCode?: ...;
                                  iban?: ...;
                                  interestMethodAssignmentCode?: ...;
                                  intraOrgCode?: ...;
                                  jurisdictionCountryCode?: ...;
                                  personId?: ...;
                                  personName?: ...;
                                  personTypeCode?: ...;
                                  productCode?: ...;
                                  relationshipType?: ...;
                                  relationshipValidityRange?: ...;
                                  residencyCode?: ...;
                                  serviceProviderCode?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusReasonCode?: ...;
                                  taxResidencyCountryCode?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/accounts/{parentAccountId}/child-accounts": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { parentAccountId: string };
                query: { pageNumber: number; pageSize: number };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                total?: number | null;
                                values?:
                                    | {
                                        accessRestricted?: ...;
                                        accountClassCode?: ...;
                                        accountId?: ...;
                                        accountName?: ...;
                                        accountNumbers?: ...;
                                        accountRelationshipId?: ...;
                                        accountTypeCode?: ...;
                                        accountTypeSetupCode?: ...;
                                        activationDate?: ...;
                                        bic?: ...;
                                        counterpartySectorCode?: ...;
                                        customerGroupCode?: ...;
                                        defaultCurrencyCode?: ...;
                                        iban?: ...;
                                        interestMethodAssignmentCode?: ...;
                                        intraOrgCode?: ...;
                                        jurisdictionCountryCode?: ...;
                                        personId?: ...;
                                        personName?: ...;
                                        personTypeCode?: ...;
                                        productCode?: ...;
                                        relationshipType?: ...;
                                        relationshipValidityRange?: ...;
                                        residencyCode?: ...;
                                        serviceProviderCode?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusReasonCode?: ...;
                                        taxResidencyCountryCode?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { parentAccountId: string };
              query: { pageNumber: number; pageSize: number };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              total?: number | null;
                              values?:
                                  | {
                                      accessRestricted?: ...;
                                      accountClassCode?: ...;
                                      accountId?: ...;
                                      accountName?: ...;
                                      accountNumbers?: ...;
                                      accountRelationshipId?: ...;
                                      accountTypeCode?: ...;
                                      accountTypeSetupCode?: ...;
                                      activationDate?: ...;
                                      bic?: ...;
                                      counterpartySectorCode?: ...;
                                      customerGroupCode?: ...;
                                      defaultCurrencyCode?: ...;
                                      iban?: ...;
                                      interestMethodAssignmentCode?: ...;
                                      intraOrgCode?: ...;
                                      jurisdictionCountryCode?: ...;
                                      personId?: ...;
                                      personName?: ...;
                                      personTypeCode?: ...;
                                      productCode?: ...;
                                      relationshipType?: ...;
                                      relationshipValidityRange?: ...;
                                      residencyCode?: ...;
                                      serviceProviderCode?: ...;
                                      source?: ...;
                                      statusCode?: ...;
                                      statusReasonCode?: ...;
                                      taxResidencyCountryCode?: ...;
                                      tenantCode?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find virtual child accounts by master account ID

      Fetches virtual child accounts by master account ID. Includes information about the master-child relationship.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { parentAccountId: string };
            query: { pageNumber: number; pageSize: number };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { parentAccountId: string }
        • query: { pageNumber: number; pageSize: number }
          • pageNumber: number

            Format - int32. Page number

          • pageSize: number

            Format - int32. Page size

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            total?: number | null;
                            values?:
                                | {
                                    accessRestricted?: ...;
                                    accountClassCode?: ...;
                                    accountId?: ...;
                                    accountName?: ...;
                                    accountNumbers?: ...;
                                    accountRelationshipId?: ...;
                                    accountTypeCode?: ...;
                                    accountTypeSetupCode?: ...;
                                    activationDate?: ...;
                                    bic?: ...;
                                    counterpartySectorCode?: ...;
                                    customerGroupCode?: ...;
                                    defaultCurrencyCode?: ...;
                                    iban?: ...;
                                    interestMethodAssignmentCode?: ...;
                                    intraOrgCode?: ...;
                                    jurisdictionCountryCode?: ...;
                                    personId?: ...;
                                    personName?: ...;
                                    personTypeCode?: ...;
                                    productCode?: ...;
                                    relationshipType?: ...;
                                    relationshipValidityRange?: ...;
                                    residencyCode?: ...;
                                    serviceProviderCode?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusReasonCode?: ...;
                                    taxResidencyCountryCode?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          total?: number | null;
                          values?:
                              | {
                                  accessRestricted?: ...;
                                  accountClassCode?: ...;
                                  accountId?: ...;
                                  accountName?: ...;
                                  accountNumbers?: ...;
                                  accountRelationshipId?: ...;
                                  accountTypeCode?: ...;
                                  accountTypeSetupCode?: ...;
                                  activationDate?: ...;
                                  bic?: ...;
                                  counterpartySectorCode?: ...;
                                  customerGroupCode?: ...;
                                  defaultCurrencyCode?: ...;
                                  iban?: ...;
                                  interestMethodAssignmentCode?: ...;
                                  intraOrgCode?: ...;
                                  jurisdictionCountryCode?: ...;
                                  personId?: ...;
                                  personName?: ...;
                                  personTypeCode?: ...;
                                  productCode?: ...;
                                  relationshipType?: ...;
                                  relationshipValidityRange?: ...;
                                  residencyCode?: ...;
                                  serviceProviderCode?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusReasonCode?: ...;
                                  taxResidencyCountryCode?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        birthDate?: string
                        | null;
                        businessAreaCodes?: string[] | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        customerTypeCode?: string | null;
                        deathDate?: string | null;
                        dependantPersons?: number | null;
                        educationCode?: string | null;
                        email?: string | null;
                        givenName?: string | null;
                        home?: {
                            buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                            housingTypeCode?:
                                | "PRIVATE"
                                | "RENTED"
                                | "PART_OWNERSHIP"
                                | "LIVING_WITH_PARENTS"
                                | "OTHER";
                        };
                        inactivationDate?: string
                        | null;
                        language?: string | null;
                        legalForm?: string | null;
                        liquidationDate?: string | null;
                        mainPersonId?: string | null;
                        maritalStatusCode?: string | null;
                        middleName?: string | null;
                        name?: string | null;
                        nationality?: string | null;
                        pep?: boolean | null;
                        pepExplanation?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        residencyCountryCode?: string | null;
                        sex?: "M" | "F" | "O";
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        statusCodeReason?: string
                        | null;
                        surname?: string | null;
                        taxResidencyCountry?: string | null;
                        tradingName?: string | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                        work?: {
                            activityCode?: string | null;
                            businessAreaCodes?: string[] | null;
                            employmentTimeCode?:
                                | "TRIAL"
                                | "UP_1_YEAR"
                                | "UP_2_YEAR"
                                | "UP_3_YEAR"
                                | "UP_4_YEAR"
                                | "MORE_4_YEAR";
                            fixedEmploymentLength?: number
                            | null;
                        };
                    };
                    "application/json": {
                        birthDate?: string
                        | null;
                        businessAreaCodes?: string[] | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        customerTypeCode?: string | null;
                        deathDate?: string | null;
                        dependantPersons?: number | null;
                        educationCode?: string | null;
                        email?: string | null;
                        givenName?: string | null;
                        home?: {
                            buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                            housingTypeCode?:
                                | "PRIVATE"
                                | "RENTED"
                                | "PART_OWNERSHIP"
                                | "LIVING_WITH_PARENTS"
                                | "OTHER";
                        };
                        inactivationDate?: string
                        | null;
                        language?: string | null;
                        legalForm?: string | null;
                        liquidationDate?: string | null;
                        mainPersonId?: string | null;
                        maritalStatusCode?: string | null;
                        middleName?: string | null;
                        name?: string | null;
                        nationality?: string | null;
                        pep?: boolean | null;
                        pepExplanation?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        residencyCountryCode?: string | null;
                        sex?: "M" | "F" | "O";
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        statusCodeReason?: string
                        | null;
                        surname?: string | null;
                        taxResidencyCountry?: string | null;
                        tradingName?: string | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                        work?: {
                            activityCode?: string | null;
                            businessAreaCodes?: string[] | null;
                            employmentTimeCode?:
                                | "TRIAL"
                                | "UP_1_YEAR"
                                | "UP_2_YEAR"
                                | "UP_3_YEAR"
                                | "UP_4_YEAR"
                                | "MORE_4_YEAR";
                            fixedEmploymentLength?: number
                            | null;
                        };
                    };
                    "text/json": {
                        birthDate?: string
                        | null;
                        businessAreaCodes?: string[] | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        customerTypeCode?: string | null;
                        deathDate?: string | null;
                        dependantPersons?: number | null;
                        educationCode?: string | null;
                        email?: string | null;
                        givenName?: string | null;
                        home?: {
                            buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                            housingTypeCode?:
                                | "PRIVATE"
                                | "RENTED"
                                | "PART_OWNERSHIP"
                                | "LIVING_WITH_PARENTS"
                                | "OTHER";
                        };
                        inactivationDate?: string
                        | null;
                        language?: string | null;
                        legalForm?: string | null;
                        liquidationDate?: string | null;
                        mainPersonId?: string | null;
                        maritalStatusCode?: string | null;
                        middleName?: string | null;
                        name?: string | null;
                        nationality?: string | null;
                        pep?: boolean | null;
                        pepExplanation?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        residencyCountryCode?: string | null;
                        sex?: "M" | "F" | "O";
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        statusCodeReason?: string
                        | null;
                        surname?: string | null;
                        taxResidencyCountry?: string | null;
                        tradingName?: string | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                        work?: {
                            activityCode?: string | null;
                            businessAreaCodes?: string[] | null;
                            employmentTimeCode?:
                                | "TRIAL"
                                | "UP_1_YEAR"
                                | "UP_2_YEAR"
                                | "UP_3_YEAR"
                                | "UP_4_YEAR"
                                | "MORE_4_YEAR";
                            fixedEmploymentLength?: number
                            | null;
                        };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                birthDate?: string | null;
                                businessAreaCodes?: string[] | null;
                                businessModelDescription?: string | null;
                                counterpartySectorCode?: string | null;
                                countryOfBirth?: string | null;
                                creationDate?: string | null;
                                customerTypeCode?: string | null;
                                deathDate?: string | null;
                                dependantPersons?: number | null;
                                educationCode?: string | null;
                                email?: string | null;
                                forgotten?: boolean | null;
                                fullName?: string | null;
                                givenName?: string | null;
                                home?: {
                                    buildingTypeCode?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                };
                                idCountryCode?: string
                                | null;
                                idNumber?: string | null;
                                inactivationDate?: string | null;
                                insertedDTime?: string | null;
                                intraOrgCode?: string | null;
                                language?: string | null;
                                legalForm?: string | null;
                                liquidationDate?: string | null;
                                mainPersonId?: string | null;
                                maritalStatusCode?: string | null;
                                middleName?: string | null;
                                name?: string | null;
                                nationality?: string | null;
                                pep?: boolean | null;
                                pepExplanation?: string | null;
                                personGroupCodes?: string[] | null;
                                personId?: string | null;
                                personTypeCode?: string | null;
                                phoneCountryCode?: string | null;
                                phoneNumber?: string | null;
                                placeOfBirth?: string | null;
                                registrationDate?: string | null;
                                residencyCountryCode?: string | null;
                                sex?: string | null;
                                source?: {
                                    sourceLink?: (...) | (...) | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                statusCode?: string
                                | null;
                                statusCodeReason?: string | null;
                                surname?: string | null;
                                taxResidencyCountry?: string | null;
                                tenantCode?: string | null;
                                tradingName?: string | null;
                                usResident?: boolean | null;
                                webAddress?: string | null;
                                work?: {
                                    activityCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • patch: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      birthDate?: string
                      | null;
                      businessAreaCodes?: string[] | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      customerTypeCode?: string | null;
                      deathDate?: string | null;
                      dependantPersons?: number | null;
                      educationCode?: string | null;
                      email?: string | null;
                      givenName?: string | null;
                      home?: {
                          buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                          housingTypeCode?:
                              | "PRIVATE"
                              | "RENTED"
                              | "PART_OWNERSHIP"
                              | "LIVING_WITH_PARENTS"
                              | "OTHER";
                      };
                      inactivationDate?: string
                      | null;
                      language?: string | null;
                      legalForm?: string | null;
                      liquidationDate?: string | null;
                      mainPersonId?: string | null;
                      maritalStatusCode?: string | null;
                      middleName?: string | null;
                      name?: string | null;
                      nationality?: string | null;
                      pep?: boolean | null;
                      pepExplanation?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      residencyCountryCode?: string | null;
                      sex?: "M" | "F" | "O";
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      statusCodeReason?: string
                      | null;
                      surname?: string | null;
                      taxResidencyCountry?: string | null;
                      tradingName?: string | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                      work?: {
                          activityCode?: string | null;
                          businessAreaCodes?: string[] | null;
                          employmentTimeCode?:
                              | "TRIAL"
                              | "UP_1_YEAR"
                              | "UP_2_YEAR"
                              | "UP_3_YEAR"
                              | "UP_4_YEAR"
                              | "MORE_4_YEAR";
                          fixedEmploymentLength?: number
                          | null;
                      };
                  };
                  "application/json": {
                      birthDate?: string
                      | null;
                      businessAreaCodes?: string[] | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      customerTypeCode?: string | null;
                      deathDate?: string | null;
                      dependantPersons?: number | null;
                      educationCode?: string | null;
                      email?: string | null;
                      givenName?: string | null;
                      home?: {
                          buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                          housingTypeCode?:
                              | "PRIVATE"
                              | "RENTED"
                              | "PART_OWNERSHIP"
                              | "LIVING_WITH_PARENTS"
                              | "OTHER";
                      };
                      inactivationDate?: string
                      | null;
                      language?: string | null;
                      legalForm?: string | null;
                      liquidationDate?: string | null;
                      mainPersonId?: string | null;
                      maritalStatusCode?: string | null;
                      middleName?: string | null;
                      name?: string | null;
                      nationality?: string | null;
                      pep?: boolean | null;
                      pepExplanation?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      residencyCountryCode?: string | null;
                      sex?: "M" | "F" | "O";
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      statusCodeReason?: string
                      | null;
                      surname?: string | null;
                      taxResidencyCountry?: string | null;
                      tradingName?: string | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                      work?: {
                          activityCode?: string | null;
                          businessAreaCodes?: string[] | null;
                          employmentTimeCode?:
                              | "TRIAL"
                              | "UP_1_YEAR"
                              | "UP_2_YEAR"
                              | "UP_3_YEAR"
                              | "UP_4_YEAR"
                              | "MORE_4_YEAR";
                          fixedEmploymentLength?: number
                          | null;
                      };
                  };
                  "text/json": {
                      birthDate?: string
                      | null;
                      businessAreaCodes?: string[] | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      customerTypeCode?: string | null;
                      deathDate?: string | null;
                      dependantPersons?: number | null;
                      educationCode?: string | null;
                      email?: string | null;
                      givenName?: string | null;
                      home?: {
                          buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                          housingTypeCode?:
                              | "PRIVATE"
                              | "RENTED"
                              | "PART_OWNERSHIP"
                              | "LIVING_WITH_PARENTS"
                              | "OTHER";
                      };
                      inactivationDate?: string
                      | null;
                      language?: string | null;
                      legalForm?: string | null;
                      liquidationDate?: string | null;
                      mainPersonId?: string | null;
                      maritalStatusCode?: string | null;
                      middleName?: string | null;
                      name?: string | null;
                      nationality?: string | null;
                      pep?: boolean | null;
                      pepExplanation?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      residencyCountryCode?: string | null;
                      sex?: "M" | "F" | "O";
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      statusCodeReason?: string
                      | null;
                      surname?: string | null;
                      taxResidencyCountry?: string | null;
                      tradingName?: string | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                      work?: {
                          activityCode?: string | null;
                          businessAreaCodes?: string[] | null;
                          employmentTimeCode?:
                              | "TRIAL"
                              | "UP_1_YEAR"
                              | "UP_2_YEAR"
                              | "UP_3_YEAR"
                              | "UP_4_YEAR"
                              | "MORE_4_YEAR";
                          fixedEmploymentLength?: number
                          | null;
                      };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              birthDate?: string | null;
                              businessAreaCodes?: string[] | null;
                              businessModelDescription?: string | null;
                              counterpartySectorCode?: string | null;
                              countryOfBirth?: string | null;
                              creationDate?: string | null;
                              customerTypeCode?: string | null;
                              deathDate?: string | null;
                              dependantPersons?: number | null;
                              educationCode?: string | null;
                              email?: string | null;
                              forgotten?: boolean | null;
                              fullName?: string | null;
                              givenName?: string | null;
                              home?: {
                                  buildingTypeCode?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                              };
                              idCountryCode?: string
                              | null;
                              idNumber?: string | null;
                              inactivationDate?: string | null;
                              insertedDTime?: string | null;
                              intraOrgCode?: string | null;
                              language?: string | null;
                              legalForm?: string | null;
                              liquidationDate?: string | null;
                              mainPersonId?: string | null;
                              maritalStatusCode?: string | null;
                              middleName?: string | null;
                              name?: string | null;
                              nationality?: string | null;
                              pep?: boolean | null;
                              pepExplanation?: string | null;
                              personGroupCodes?: string[] | null;
                              personId?: string | null;
                              personTypeCode?: string | null;
                              phoneCountryCode?: string | null;
                              phoneNumber?: string | null;
                              placeOfBirth?: string | null;
                              registrationDate?: string | null;
                              residencyCountryCode?: string | null;
                              sex?: string | null;
                              source?: {
                                  sourceLink?: (...) | (...) | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              statusCode?: string
                              | null;
                              statusCodeReason?: string | null;
                              surname?: string | null;
                              taxResidencyCountry?: string | null;
                              tenantCode?: string | null;
                              tradingName?: string | null;
                              usResident?: boolean | null;
                              webAddress?: string | null;
                              work?: {
                                  activityCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Changes personal information of a person

      Update personal information for either a private or a legal person. Including sex (gender), nationality, and residency country code Updates only the specified fields of a person. Fields not included in the request remain unchanged. Null values explicitly set fields to null. Missing fields are ignored.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    birthDate?: string | null;
                    businessAreaCodes?: string[] | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    customerTypeCode?: string | null;
                    deathDate?: string | null;
                    dependantPersons?: number | null;
                    educationCode?: string | null;
                    email?: string | null;
                    givenName?: string | null;
                    home?: {
                        buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                        housingTypeCode?:
                            | "PRIVATE"
                            | "RENTED"
                            | "PART_OWNERSHIP"
                            | "LIVING_WITH_PARENTS"
                            | "OTHER";
                    };
                    inactivationDate?: string
                    | null;
                    language?: string | null;
                    legalForm?: string | null;
                    liquidationDate?: string | null;
                    mainPersonId?: string | null;
                    maritalStatusCode?: string | null;
                    middleName?: string | null;
                    name?: string | null;
                    nationality?: string | null;
                    pep?: boolean | null;
                    pepExplanation?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    residencyCountryCode?: string | null;
                    sex?: "M" | "F" | "O";
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    statusCodeReason?: string
                    | null;
                    surname?: string | null;
                    taxResidencyCountry?: string | null;
                    tradingName?: string | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                    work?: {
                        activityCode?: string | null;
                        businessAreaCodes?: string[] | null;
                        employmentTimeCode?:
                            | "TRIAL"
                            | "UP_1_YEAR"
                            | "UP_2_YEAR"
                            | "UP_3_YEAR"
                            | "UP_4_YEAR"
                            | "MORE_4_YEAR";
                        fixedEmploymentLength?: number
                        | null;
                    };
                };
                "application/json": {
                    birthDate?: string
                    | null;
                    businessAreaCodes?: string[] | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    customerTypeCode?: string | null;
                    deathDate?: string | null;
                    dependantPersons?: number | null;
                    educationCode?: string | null;
                    email?: string | null;
                    givenName?: string | null;
                    home?: {
                        buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                        housingTypeCode?:
                            | "PRIVATE"
                            | "RENTED"
                            | "PART_OWNERSHIP"
                            | "LIVING_WITH_PARENTS"
                            | "OTHER";
                    };
                    inactivationDate?: string
                    | null;
                    language?: string | null;
                    legalForm?: string | null;
                    liquidationDate?: string | null;
                    mainPersonId?: string | null;
                    maritalStatusCode?: string | null;
                    middleName?: string | null;
                    name?: string | null;
                    nationality?: string | null;
                    pep?: boolean | null;
                    pepExplanation?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    residencyCountryCode?: string | null;
                    sex?: "M" | "F" | "O";
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    statusCodeReason?: string
                    | null;
                    surname?: string | null;
                    taxResidencyCountry?: string | null;
                    tradingName?: string | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                    work?: {
                        activityCode?: string | null;
                        businessAreaCodes?: string[] | null;
                        employmentTimeCode?:
                            | "TRIAL"
                            | "UP_1_YEAR"
                            | "UP_2_YEAR"
                            | "UP_3_YEAR"
                            | "UP_4_YEAR"
                            | "MORE_4_YEAR";
                        fixedEmploymentLength?: number
                        | null;
                    };
                };
                "text/json": {
                    birthDate?: string
                    | null;
                    businessAreaCodes?: string[] | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    customerTypeCode?: string | null;
                    deathDate?: string | null;
                    dependantPersons?: number | null;
                    educationCode?: string | null;
                    email?: string | null;
                    givenName?: string | null;
                    home?: {
                        buildingTypeCode?: "OTHER" | "PRIVATE_HOUSE" | "APARTMENT";
                        housingTypeCode?:
                            | "PRIVATE"
                            | "RENTED"
                            | "PART_OWNERSHIP"
                            | "LIVING_WITH_PARENTS"
                            | "OTHER";
                    };
                    inactivationDate?: string
                    | null;
                    language?: string | null;
                    legalForm?: string | null;
                    liquidationDate?: string | null;
                    mainPersonId?: string | null;
                    maritalStatusCode?: string | null;
                    middleName?: string | null;
                    name?: string | null;
                    nationality?: string | null;
                    pep?: boolean | null;
                    pepExplanation?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    residencyCountryCode?: string | null;
                    sex?: "M" | "F" | "O";
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    statusCodeReason?: string
                    | null;
                    surname?: string | null;
                    taxResidencyCountry?: string | null;
                    tradingName?: string | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                    work?: {
                        activityCode?: string | null;
                        businessAreaCodes?: string[] | null;
                        employmentTimeCode?:
                            | "TRIAL"
                            | "UP_1_YEAR"
                            | "UP_2_YEAR"
                            | "UP_3_YEAR"
                            | "UP_4_YEAR"
                            | "MORE_4_YEAR";
                        fixedEmploymentLength?: number
                        | null;
                    };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            birthDate?: string | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            creationDate?: string | null;
                            customerTypeCode?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?: string | null;
                            email?: string | null;
                            forgotten?: boolean | null;
                            fullName?: string | null;
                            givenName?: string | null;
                            home?: {
                                buildingTypeCode?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                            };
                            idCountryCode?: string
                            | null;
                            idNumber?: string | null;
                            inactivationDate?: string | null;
                            insertedDTime?: string | null;
                            intraOrgCode?: string | null;
                            language?: string | null;
                            legalForm?: string | null;
                            liquidationDate?: string | null;
                            mainPersonId?: string | null;
                            maritalStatusCode?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personId?: string | null;
                            personTypeCode?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: string | null;
                            source?: {
                                sourceLink?: (...) | (...) | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCode?: string
                            | null;
                            statusCodeReason?: string | null;
                            surname?: string | null;
                            taxResidencyCountry?: string | null;
                            tenantCode?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                            work?: {
                                activityCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          birthDate?: string | null;
                          businessAreaCodes?: string[] | null;
                          businessModelDescription?: string | null;
                          counterpartySectorCode?: string | null;
                          countryOfBirth?: string | null;
                          creationDate?: string | null;
                          customerTypeCode?: string | null;
                          deathDate?: string | null;
                          dependantPersons?: number | null;
                          educationCode?: string | null;
                          email?: string | null;
                          forgotten?: boolean | null;
                          fullName?: string | null;
                          givenName?: string | null;
                          home?: {
                              buildingTypeCode?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                          };
                          idCountryCode?: string
                          | null;
                          idNumber?: string | null;
                          inactivationDate?: string | null;
                          insertedDTime?: string | null;
                          intraOrgCode?: string | null;
                          language?: string | null;
                          legalForm?: string | null;
                          liquidationDate?: string | null;
                          mainPersonId?: string | null;
                          maritalStatusCode?: string | null;
                          middleName?: string | null;
                          name?: string | null;
                          nationality?: string | null;
                          pep?: boolean | null;
                          pepExplanation?: string | null;
                          personGroupCodes?: string[] | null;
                          personId?: string | null;
                          personTypeCode?: string | null;
                          phoneCountryCode?: string | null;
                          phoneNumber?: string | null;
                          placeOfBirth?: string | null;
                          registrationDate?: string | null;
                          residencyCountryCode?: string | null;
                          sex?: string | null;
                          source?: {
                              sourceLink?: (...) | (...) | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          statusCode?: string
                          | null;
                          statusCodeReason?: string | null;
                          surname?: string | null;
                          taxResidencyCountry?: string | null;
                          tenantCode?: string | null;
                          tradingName?: string | null;
                          usResident?: boolean | null;
                          webAddress?: string | null;
                          work?: {
                              activityCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/activate": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                additionalContacts?:
                                    | {
                                        additionalContactId?: ...;
                                        contactTypeCode?: ...;
                                        description?: ...;
                                        email?: ...;
                                        personId?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        preferredMethodOfContact?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                additionalInfo?: {
                                    birthDate?: (...)
                                    | (...)
                                    | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                addresses?: | {
                                    addressId?: ...;
                                    addressTypeCode?: ...;
                                    apartmentNumber?: ...;
                                    buildingName?: ...;
                                    buildingNumber?: ...;
                                    cityCounty?: ...;
                                    countryCode?: ...;
                                    department?: ...;
                                    district?: ...;
                                    floor?: ...;
                                    moveInDate?: ...;
                                    personId?: ...;
                                    postBox?: ...;
                                    stateRegion?: ...;
                                    street1?: ...;
                                    street2?: ...;
                                    streetName?: ...;
                                    structured?: ...;
                                    subDepartment?: ...;
                                    townLocationName?: ...;
                                    validityRange?: ...;
                                    zip?: ...;
                                }[]
                                | null;
                                creationDate?: string
                                | null;
                                documents?:
                                    | {
                                        docuId?: ...;
                                        documentTypeCode?: ...;
                                        expiryDate?: ...;
                                        issuingCountry?: ...;
                                        number?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                forgotten?: boolean
                                | null;
                                fullName?: string | null;
                                home?: {
                                    buildingTypeCode?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                };
                                identificationNumbers?: | {
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    idNumberId?: ...;
                                    personId?: ...;
                                    primary?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                legalForm?: string
                                | null;
                                mainPersonId?: string | null;
                                personalInfo?: {
                                    dependantPersons?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                };
                                personGroupCodes?: | {
                                    personGroupCode: ...;
                                    personGroupId?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                personId?: string
                                | null;
                                relationships?:
                                    | {
                                        additionalData?: ...;
                                        beneficiary?: ...;
                                        parent?: ...;
                                        parentPersonId?: ...;
                                        percentageOfShares?: ...;
                                        percentageOfSignature?: ...;
                                        person?: ...;
                                        personId?: ...;
                                        personRelationshipId?: ...;
                                        relationTypeCode?: ...;
                                        representingRange?: ...;
                                        role?: ...;
                                        statusCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                source?: {
                                    sourceLink?: (...)
                                    | (...)
                                    | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                statusCode?: string
                                | null;
                                taxNumbers?:
                                    | {
                                        personId?: ...;
                                        primary?: ...;
                                        taxCountryCode?: ...;
                                        taxNumber?: ...;
                                        taxNumberId?: ...;
                                        taxNumberTypeCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                tenantCode?: string
                                | null;
                                work?: {
                                    activityCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              additionalContacts?:
                                  | {
                                      additionalContactId?: ...;
                                      contactTypeCode?: ...;
                                      description?: ...;
                                      email?: ...;
                                      personId?: ...;
                                      phoneCountryCode?: ...;
                                      phoneNumber?: ...;
                                      preferredMethodOfContact?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              additionalInfo?: {
                                  birthDate?: (...)
                                  | (...)
                                  | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              addresses?: | {
                                  addressId?: ...;
                                  addressTypeCode?: ...;
                                  apartmentNumber?: ...;
                                  buildingName?: ...;
                                  buildingNumber?: ...;
                                  cityCounty?: ...;
                                  countryCode?: ...;
                                  department?: ...;
                                  district?: ...;
                                  floor?: ...;
                                  moveInDate?: ...;
                                  personId?: ...;
                                  postBox?: ...;
                                  stateRegion?: ...;
                                  street1?: ...;
                                  street2?: ...;
                                  streetName?: ...;
                                  structured?: ...;
                                  subDepartment?: ...;
                                  townLocationName?: ...;
                                  validityRange?: ...;
                                  zip?: ...;
                              }[]
                              | null;
                              creationDate?: string
                              | null;
                              documents?:
                                  | {
                                      docuId?: ...;
                                      documentTypeCode?: ...;
                                      expiryDate?: ...;
                                      issuingCountry?: ...;
                                      number?: ...;
                                      personId?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              forgotten?: boolean
                              | null;
                              fullName?: string | null;
                              home?: {
                                  buildingTypeCode?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                              };
                              identificationNumbers?: | {
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  idNumberId?: ...;
                                  personId?: ...;
                                  primary?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              legalForm?: string
                              | null;
                              mainPersonId?: string | null;
                              personalInfo?: {
                                  dependantPersons?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                              };
                              personGroupCodes?: | {
                                  personGroupCode: ...;
                                  personGroupId?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              personId?: string
                              | null;
                              relationships?:
                                  | {
                                      additionalData?: ...;
                                      beneficiary?: ...;
                                      parent?: ...;
                                      parentPersonId?: ...;
                                      percentageOfShares?: ...;
                                      percentageOfSignature?: ...;
                                      person?: ...;
                                      personId?: ...;
                                      personRelationshipId?: ...;
                                      relationTypeCode?: ...;
                                      representingRange?: ...;
                                      role?: ...;
                                      statusCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              source?: {
                                  sourceLink?: (...)
                                  | (...)
                                  | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              statusCode?: string
                              | null;
                              taxNumbers?:
                                  | {
                                      personId?: ...;
                                      primary?: ...;
                                      taxCountryCode?: ...;
                                      taxNumber?: ...;
                                      taxNumberId?: ...;
                                      taxNumberTypeCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              tenantCode?: string
                              | null;
                              work?: {
                                  activityCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Activate person

      Sets a person in an active state

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            additionalContacts?:
                                | {
                                    additionalContactId?: ...;
                                    contactTypeCode?: ...;
                                    description?: ...;
                                    email?: ...;
                                    personId?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    preferredMethodOfContact?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            additionalInfo?: {
                                birthDate?: (...)
                                | (...)
                                | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            addresses?: | {
                                addressId?: ...;
                                addressTypeCode?: ...;
                                apartmentNumber?: ...;
                                buildingName?: ...;
                                buildingNumber?: ...;
                                cityCounty?: ...;
                                countryCode?: ...;
                                department?: ...;
                                district?: ...;
                                floor?: ...;
                                moveInDate?: ...;
                                personId?: ...;
                                postBox?: ...;
                                stateRegion?: ...;
                                street1?: ...;
                                street2?: ...;
                                streetName?: ...;
                                structured?: ...;
                                subDepartment?: ...;
                                townLocationName?: ...;
                                validityRange?: ...;
                                zip?: ...;
                            }[]
                            | null;
                            creationDate?: string
                            | null;
                            documents?:
                                | {
                                    docuId?: ...;
                                    documentTypeCode?: ...;
                                    expiryDate?: ...;
                                    issuingCountry?: ...;
                                    number?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            forgotten?: boolean
                            | null;
                            fullName?: string | null;
                            home?: {
                                buildingTypeCode?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                            };
                            identificationNumbers?: | {
                                idCountryCode?: ...;
                                idNumber?: ...;
                                idNumberId?: ...;
                                personId?: ...;
                                primary?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            legalForm?: string
                            | null;
                            mainPersonId?: string | null;
                            personalInfo?: {
                                dependantPersons?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                            };
                            personGroupCodes?: | {
                                personGroupCode: ...;
                                personGroupId?: ...;
                                personId?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            personId?: string
                            | null;
                            relationships?:
                                | {
                                    additionalData?: ...;
                                    beneficiary?: ...;
                                    parent?: ...;
                                    parentPersonId?: ...;
                                    percentageOfShares?: ...;
                                    percentageOfSignature?: ...;
                                    person?: ...;
                                    personId?: ...;
                                    personRelationshipId?: ...;
                                    relationTypeCode?: ...;
                                    representingRange?: ...;
                                    role?: ...;
                                    statusCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            source?: {
                                sourceLink?: (...)
                                | (...)
                                | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCode?: string
                            | null;
                            taxNumbers?:
                                | {
                                    personId?: ...;
                                    primary?: ...;
                                    taxCountryCode?: ...;
                                    taxNumber?: ...;
                                    taxNumberId?: ...;
                                    taxNumberTypeCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            tenantCode?: string
                            | null;
                            work?: {
                                activityCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          additionalContacts?:
                              | {
                                  additionalContactId?: ...;
                                  contactTypeCode?: ...;
                                  description?: ...;
                                  email?: ...;
                                  personId?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  preferredMethodOfContact?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          additionalInfo?: {
                              birthDate?: (...)
                              | (...)
                              | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          addresses?: | {
                              addressId?: ...;
                              addressTypeCode?: ...;
                              apartmentNumber?: ...;
                              buildingName?: ...;
                              buildingNumber?: ...;
                              cityCounty?: ...;
                              countryCode?: ...;
                              department?: ...;
                              district?: ...;
                              floor?: ...;
                              moveInDate?: ...;
                              personId?: ...;
                              postBox?: ...;
                              stateRegion?: ...;
                              street1?: ...;
                              street2?: ...;
                              streetName?: ...;
                              structured?: ...;
                              subDepartment?: ...;
                              townLocationName?: ...;
                              validityRange?: ...;
                              zip?: ...;
                          }[]
                          | null;
                          creationDate?: string
                          | null;
                          documents?:
                              | {
                                  docuId?: ...;
                                  documentTypeCode?: ...;
                                  expiryDate?: ...;
                                  issuingCountry?: ...;
                                  number?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          forgotten?: boolean
                          | null;
                          fullName?: string | null;
                          home?: {
                              buildingTypeCode?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                          };
                          identificationNumbers?: | {
                              idCountryCode?: ...;
                              idNumber?: ...;
                              idNumberId?: ...;
                              personId?: ...;
                              primary?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          legalForm?: string
                          | null;
                          mainPersonId?: string | null;
                          personalInfo?: {
                              dependantPersons?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                          };
                          personGroupCodes?: | {
                              personGroupCode: ...;
                              personGroupId?: ...;
                              personId?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          personId?: string
                          | null;
                          relationships?:
                              | {
                                  additionalData?: ...;
                                  beneficiary?: ...;
                                  parent?: ...;
                                  parentPersonId?: ...;
                                  percentageOfShares?: ...;
                                  percentageOfSignature?: ...;
                                  person?: ...;
                                  personId?: ...;
                                  personRelationshipId?: ...;
                                  relationTypeCode?: ...;
                                  representingRange?: ...;
                                  role?: ...;
                                  statusCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          source?: {
                              sourceLink?: (...)
                              | (...)
                              | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          statusCode?: string
                          | null;
                          taxNumbers?:
                              | {
                                  personId?: ...;
                                  primary?: ...;
                                  taxCountryCode?: ...;
                                  taxNumber?: ...;
                                  taxNumberId?: ...;
                                  taxNumberTypeCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          tenantCode?: string
                          | null;
                          work?: {
                              activityCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/additional": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        birthDate?: string
                        | null;
                        businessAreaCodes?: string[] | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        deathDate?: string | null;
                        dependantPersons?: number | null;
                        educationCode?:
                            | "PRIMARY"
                            | "SECONDARY"
                            | "VOCATIONAL_SCHOOL"
                            | "HIGHER_EDUCATION";
                        inactivationDate?: string
                        | null;
                        language?: string | null;
                        liquidationDate?: string | null;
                        maritalStatusCode?:
                            | "SINGLE"
                            | "MARRIED"
                            | "DIVORCED"
                            | "WIDOW"
                            | "COHABITANT";
                        pep?: boolean
                        | null;
                        pepExplanation?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        statusCodeReason?: string | null;
                        taxResidencyCountry?: string | null;
                        tradingName?: string | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                    };
                    "application/json": {
                        birthDate?: string
                        | null;
                        businessAreaCodes?: string[] | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        deathDate?: string | null;
                        dependantPersons?: number | null;
                        educationCode?:
                            | "PRIMARY"
                            | "SECONDARY"
                            | "VOCATIONAL_SCHOOL"
                            | "HIGHER_EDUCATION";
                        inactivationDate?: string
                        | null;
                        language?: string | null;
                        liquidationDate?: string | null;
                        maritalStatusCode?:
                            | "SINGLE"
                            | "MARRIED"
                            | "DIVORCED"
                            | "WIDOW"
                            | "COHABITANT";
                        pep?: boolean
                        | null;
                        pepExplanation?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        statusCodeReason?: string | null;
                        taxResidencyCountry?: string | null;
                        tradingName?: string | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                    };
                    "text/json": {
                        birthDate?: string
                        | null;
                        businessAreaCodes?: string[] | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        deathDate?: string | null;
                        dependantPersons?: number | null;
                        educationCode?:
                            | "PRIMARY"
                            | "SECONDARY"
                            | "VOCATIONAL_SCHOOL"
                            | "HIGHER_EDUCATION";
                        inactivationDate?: string
                        | null;
                        language?: string | null;
                        liquidationDate?: string | null;
                        maritalStatusCode?:
                            | "SINGLE"
                            | "MARRIED"
                            | "DIVORCED"
                            | "WIDOW"
                            | "COHABITANT";
                        pep?: boolean
                        | null;
                        pepExplanation?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        statusCodeReason?: string | null;
                        taxResidencyCountry?: string | null;
                        tradingName?: string | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                birthDate?: string
                                | null;
                                businessAreaCodes?: string[] | null;
                                businessModelDescription?: string | null;
                                counterpartySectorCode?: string | null;
                                countryOfBirth?: string | null;
                                customerTypeCode?: string | null;
                                deathDate?: string | null;
                                dependantPersons?: number | null;
                                educationCode?: string | null;
                                inactivationDate?: string | null;
                                intraOrgCode?: string | null;
                                language?: string | null;
                                liquidationDate?: string | null;
                                mainPersonId?: string | null;
                                maritalStatusCode?: string | null;
                                pep?: boolean | null;
                                pepExplanation?: string | null;
                                placeOfBirth?: string | null;
                                registrationDate?: string | null;
                                statusCodeReason?: string | null;
                                taxResidencyCountry?: string | null;
                                tradingName?: string | null;
                                usResident?: boolean | null;
                                webAddress?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      birthDate?: string
                      | null;
                      businessAreaCodes?: string[] | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      deathDate?: string | null;
                      dependantPersons?: number | null;
                      educationCode?:
                          | "PRIMARY"
                          | "SECONDARY"
                          | "VOCATIONAL_SCHOOL"
                          | "HIGHER_EDUCATION";
                      inactivationDate?: string
                      | null;
                      language?: string | null;
                      liquidationDate?: string | null;
                      maritalStatusCode?:
                          | "SINGLE"
                          | "MARRIED"
                          | "DIVORCED"
                          | "WIDOW"
                          | "COHABITANT";
                      pep?: boolean
                      | null;
                      pepExplanation?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      statusCodeReason?: string | null;
                      taxResidencyCountry?: string | null;
                      tradingName?: string | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                  };
                  "application/json": {
                      birthDate?: string
                      | null;
                      businessAreaCodes?: string[] | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      deathDate?: string | null;
                      dependantPersons?: number | null;
                      educationCode?:
                          | "PRIMARY"
                          | "SECONDARY"
                          | "VOCATIONAL_SCHOOL"
                          | "HIGHER_EDUCATION";
                      inactivationDate?: string
                      | null;
                      language?: string | null;
                      liquidationDate?: string | null;
                      maritalStatusCode?:
                          | "SINGLE"
                          | "MARRIED"
                          | "DIVORCED"
                          | "WIDOW"
                          | "COHABITANT";
                      pep?: boolean
                      | null;
                      pepExplanation?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      statusCodeReason?: string | null;
                      taxResidencyCountry?: string | null;
                      tradingName?: string | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                  };
                  "text/json": {
                      birthDate?: string
                      | null;
                      businessAreaCodes?: string[] | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      deathDate?: string | null;
                      dependantPersons?: number | null;
                      educationCode?:
                          | "PRIMARY"
                          | "SECONDARY"
                          | "VOCATIONAL_SCHOOL"
                          | "HIGHER_EDUCATION";
                      inactivationDate?: string
                      | null;
                      language?: string | null;
                      liquidationDate?: string | null;
                      maritalStatusCode?:
                          | "SINGLE"
                          | "MARRIED"
                          | "DIVORCED"
                          | "WIDOW"
                          | "COHABITANT";
                      pep?: boolean
                      | null;
                      pepExplanation?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      statusCodeReason?: string | null;
                      taxResidencyCountry?: string | null;
                      tradingName?: string | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              birthDate?: string
                              | null;
                              businessAreaCodes?: string[] | null;
                              businessModelDescription?: string | null;
                              counterpartySectorCode?: string | null;
                              countryOfBirth?: string | null;
                              customerTypeCode?: string | null;
                              deathDate?: string | null;
                              dependantPersons?: number | null;
                              educationCode?: string | null;
                              inactivationDate?: string | null;
                              intraOrgCode?: string | null;
                              language?: string | null;
                              liquidationDate?: string | null;
                              mainPersonId?: string | null;
                              maritalStatusCode?: string | null;
                              pep?: boolean | null;
                              pepExplanation?: string | null;
                              placeOfBirth?: string | null;
                              registrationDate?: string | null;
                              statusCodeReason?: string | null;
                              taxResidencyCountry?: string | null;
                              tradingName?: string | null;
                              usResident?: boolean | null;
                              webAddress?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Changes additional information of a person

      Update additional information for either a private or a legal person. Including date of birth, country of birth, pep, registration date, counterparty sector (NAICS) code, and web address. Please refer to the full list of counterparty sectors (NAICS) list here: https://docs.zenus.io/docs/naics-codes Deprecated. Use PATCH /api/v1/persons/{personId} instead. Changes additional information of a person. The person must be in PENDING or ACTIVE status

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    birthDate?: string | null;
                    businessAreaCodes?: string[] | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    deathDate?: string | null;
                    dependantPersons?: number | null;
                    educationCode?:
                        | "PRIMARY"
                        | "SECONDARY"
                        | "VOCATIONAL_SCHOOL"
                        | "HIGHER_EDUCATION";
                    inactivationDate?: string
                    | null;
                    language?: string | null;
                    liquidationDate?: string | null;
                    maritalStatusCode?:
                        | "SINGLE"
                        | "MARRIED"
                        | "DIVORCED"
                        | "WIDOW"
                        | "COHABITANT";
                    pep?: boolean
                    | null;
                    pepExplanation?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    statusCodeReason?: string | null;
                    taxResidencyCountry?: string | null;
                    tradingName?: string | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                };
                "application/json": {
                    birthDate?: string
                    | null;
                    businessAreaCodes?: string[] | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    deathDate?: string | null;
                    dependantPersons?: number | null;
                    educationCode?:
                        | "PRIMARY"
                        | "SECONDARY"
                        | "VOCATIONAL_SCHOOL"
                        | "HIGHER_EDUCATION";
                    inactivationDate?: string
                    | null;
                    language?: string | null;
                    liquidationDate?: string | null;
                    maritalStatusCode?:
                        | "SINGLE"
                        | "MARRIED"
                        | "DIVORCED"
                        | "WIDOW"
                        | "COHABITANT";
                    pep?: boolean
                    | null;
                    pepExplanation?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    statusCodeReason?: string | null;
                    taxResidencyCountry?: string | null;
                    tradingName?: string | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                };
                "text/json": {
                    birthDate?: string
                    | null;
                    businessAreaCodes?: string[] | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    deathDate?: string | null;
                    dependantPersons?: number | null;
                    educationCode?:
                        | "PRIMARY"
                        | "SECONDARY"
                        | "VOCATIONAL_SCHOOL"
                        | "HIGHER_EDUCATION";
                    inactivationDate?: string
                    | null;
                    language?: string | null;
                    liquidationDate?: string | null;
                    maritalStatusCode?:
                        | "SINGLE"
                        | "MARRIED"
                        | "DIVORCED"
                        | "WIDOW"
                        | "COHABITANT";
                    pep?: boolean
                    | null;
                    pepExplanation?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    statusCodeReason?: string | null;
                    taxResidencyCountry?: string | null;
                    tradingName?: string | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            birthDate?: string | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            customerTypeCode?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?: string | null;
                            inactivationDate?: string | null;
                            intraOrgCode?: string | null;
                            language?: string | null;
                            liquidationDate?: string | null;
                            mainPersonId?: string | null;
                            maritalStatusCode?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            statusCodeReason?: string | null;
                            taxResidencyCountry?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          birthDate?: string | null;
                          businessAreaCodes?: string[] | null;
                          businessModelDescription?: string | null;
                          counterpartySectorCode?: string | null;
                          countryOfBirth?: string | null;
                          customerTypeCode?: string | null;
                          deathDate?: string | null;
                          dependantPersons?: number | null;
                          educationCode?: string | null;
                          inactivationDate?: string | null;
                          intraOrgCode?: string | null;
                          language?: string | null;
                          liquidationDate?: string | null;
                          mainPersonId?: string | null;
                          maritalStatusCode?: string | null;
                          pep?: boolean | null;
                          pepExplanation?: string | null;
                          placeOfBirth?: string | null;
                          registrationDate?: string | null;
                          statusCodeReason?: string | null;
                          taxResidencyCountry?: string | null;
                          tradingName?: string | null;
                          usResident?: boolean | null;
                          webAddress?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/addresses": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                addressId?: string
                                | null;
                                addressTypeCode?: string | null;
                                apartmentNumber?: string | null;
                                buildingName?: string | null;
                                buildingNumber?: string | null;
                                cityCounty?: string | null;
                                countryCode?: string | null;
                                department?: string | null;
                                district?: string | null;
                                floor?: string | null;
                                moveInDate?: string | null;
                                personId?: string | null;
                                postBox?: string | null;
                                stateRegion?: string | null;
                                street1?: string | null;
                                street2?: string | null;
                                streetName?: string | null;
                                structured?: boolean | null;
                                subDepartment?: string | null;
                                townLocationName?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                                zip?: string
                                | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              addressId?: string
                              | null;
                              addressTypeCode?: string | null;
                              apartmentNumber?: string | null;
                              buildingName?: string | null;
                              buildingNumber?: string | null;
                              cityCounty?: string | null;
                              countryCode?: string | null;
                              department?: string | null;
                              district?: string | null;
                              floor?: string | null;
                              moveInDate?: string | null;
                              personId?: string | null;
                              postBox?: string | null;
                              stateRegion?: string | null;
                              street1?: string | null;
                              street2?: string | null;
                              streetName?: string | null;
                              structured?: boolean | null;
                              subDepartment?: string | null;
                              townLocationName?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                              zip?: string
                              | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find person addresses

      Fetches all addresses of a person

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            addressId?: string | null;
                            addressTypeCode?: string | null;
                            apartmentNumber?: string | null;
                            buildingName?: string | null;
                            buildingNumber?: string | null;
                            cityCounty?: string | null;
                            countryCode?: string | null;
                            department?: string | null;
                            district?: string | null;
                            floor?: string | null;
                            moveInDate?: string | null;
                            personId?: string | null;
                            postBox?: string | null;
                            stateRegion?: string | null;
                            street1?: string | null;
                            street2?: string | null;
                            streetName?: string | null;
                            structured?: boolean | null;
                            subDepartment?: string | null;
                            townLocationName?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                            zip?: string
                            | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          addressId?: string | null;
                          addressTypeCode?: string | null;
                          apartmentNumber?: string | null;
                          buildingName?: string | null;
                          buildingNumber?: string | null;
                          cityCounty?: string | null;
                          countryCode?: string | null;
                          department?: string | null;
                          district?: string | null;
                          floor?: string | null;
                          moveInDate?: string | null;
                          personId?: string | null;
                          postBox?: string | null;
                          stateRegion?: string | null;
                          street1?: string | null;
                          street2?: string | null;
                          streetName?: string | null;
                          structured?: boolean | null;
                          subDepartment?: string | null;
                          townLocationName?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                          zip?: string
                          | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/personal": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        email?: string
                        | null;
                        givenName?: string | null;
                        legalForm?: string | null;
                        middleName?: string | null;
                        name?: string | null;
                        nationality?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        residencyCountryCode?: string | null;
                        sex?: "M" | "F" | "O";
                        surname?: string | null;
                    };
                    "application/json": {
                        email?: string
                        | null;
                        givenName?: string | null;
                        legalForm?: string | null;
                        middleName?: string | null;
                        name?: string | null;
                        nationality?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        residencyCountryCode?: string | null;
                        sex?: "M" | "F" | "O";
                        surname?: string | null;
                    };
                    "text/json": {
                        email?: string
                        | null;
                        givenName?: string | null;
                        legalForm?: string | null;
                        middleName?: string | null;
                        name?: string | null;
                        nationality?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        residencyCountryCode?: string | null;
                        sex?: "M" | "F" | "O";
                        surname?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                dependantPersons?: number
                                | null;
                                email?: string | null;
                                givenName?: string | null;
                                legalForm?: string | null;
                                middleName?: string | null;
                                name?: string | null;
                                nationality?: string | null;
                                personTypeCode?: string | null;
                                phoneCountryCode?: string | null;
                                phoneNumber?: string | null;
                                residencyCountryCode?: string | null;
                                sex?: string | null;
                                surname?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      email?: string
                      | null;
                      givenName?: string | null;
                      legalForm?: string | null;
                      middleName?: string | null;
                      name?: string | null;
                      nationality?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      residencyCountryCode?: string | null;
                      sex?: "M" | "F" | "O";
                      surname?: string | null;
                  };
                  "application/json": {
                      email?: string
                      | null;
                      givenName?: string | null;
                      legalForm?: string | null;
                      middleName?: string | null;
                      name?: string | null;
                      nationality?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      residencyCountryCode?: string | null;
                      sex?: "M" | "F" | "O";
                      surname?: string | null;
                  };
                  "text/json": {
                      email?: string
                      | null;
                      givenName?: string | null;
                      legalForm?: string | null;
                      middleName?: string | null;
                      name?: string | null;
                      nationality?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      residencyCountryCode?: string | null;
                      sex?: "M" | "F" | "O";
                      surname?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              dependantPersons?: number
                              | null;
                              email?: string | null;
                              givenName?: string | null;
                              legalForm?: string | null;
                              middleName?: string | null;
                              name?: string | null;
                              nationality?: string | null;
                              personTypeCode?: string | null;
                              phoneCountryCode?: string | null;
                              phoneNumber?: string | null;
                              residencyCountryCode?: string | null;
                              sex?: string | null;
                              surname?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Changes personal information of a person

      Update personal information for either a private or a legal person. Including sex (gender), nationality, and residency country code Deprecated. Use PATCH /api/v1/persons/{personId} instead. Changes additional information of a person. The person must be in PENDING or ACTIVE status

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    email?: string | null;
                    givenName?: string | null;
                    legalForm?: string | null;
                    middleName?: string | null;
                    name?: string | null;
                    nationality?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    residencyCountryCode?: string | null;
                    sex?: "M" | "F" | "O";
                    surname?: string | null;
                };
                "application/json": {
                    email?: string
                    | null;
                    givenName?: string | null;
                    legalForm?: string | null;
                    middleName?: string | null;
                    name?: string | null;
                    nationality?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    residencyCountryCode?: string | null;
                    sex?: "M" | "F" | "O";
                    surname?: string | null;
                };
                "text/json": {
                    email?: string
                    | null;
                    givenName?: string | null;
                    legalForm?: string | null;
                    middleName?: string | null;
                    name?: string | null;
                    nationality?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    residencyCountryCode?: string | null;
                    sex?: "M" | "F" | "O";
                    surname?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            dependantPersons?: number | null;
                            email?: string | null;
                            givenName?: string | null;
                            legalForm?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            personTypeCode?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: string | null;
                            surname?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          dependantPersons?: number | null;
                          email?: string | null;
                          givenName?: string | null;
                          legalForm?: string | null;
                          middleName?: string | null;
                          name?: string | null;
                          nationality?: string | null;
                          personTypeCode?: string | null;
                          phoneCountryCode?: string | null;
                          phoneNumber?: string | null;
                          residencyCountryCode?: string | null;
                          sex?: string | null;
                          surname?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/relations": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        relationships: {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            customFields?: { [key: string]: unknown } | null;
                            idCountryCode: string;
                            idNumber: string;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            relationTypeCode:
                                | "REPRESENTATIVE"
                                | "SHAREHOLDER"
                                | "DIRECTOR"
                                | "MEMBER_OF_BOARD"
                                | "SUPERVISORY_BOARD_MEMBER"
                                | "EXECUTIVE_OFFICER"
                                | "ACCOUNTANT";
                            representingRange: {
                                endDate?: string
                                | null;
                                startDate?: string | null;
                            };
                            role?: string
                            | null;
                            source?: { sourceName: string; sourceRef: string };
                            statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                        }[];
                    };
                    "application/json": {
                        relationships: {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            customFields?: { [key: string]: unknown } | null;
                            idCountryCode: string;
                            idNumber: string;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            relationTypeCode:
                                | "REPRESENTATIVE"
                                | "SHAREHOLDER"
                                | "DIRECTOR"
                                | "MEMBER_OF_BOARD"
                                | "SUPERVISORY_BOARD_MEMBER"
                                | "EXECUTIVE_OFFICER"
                                | "ACCOUNTANT";
                            representingRange: {
                                endDate?: string
                                | null;
                                startDate?: string | null;
                            };
                            role?: string
                            | null;
                            source?: { sourceName: string; sourceRef: string };
                            statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                        }[];
                    };
                    "text/json": {
                        relationships: {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            customFields?: { [key: string]: unknown } | null;
                            idCountryCode: string;
                            idNumber: string;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            relationTypeCode:
                                | "REPRESENTATIVE"
                                | "SHAREHOLDER"
                                | "DIRECTOR"
                                | "MEMBER_OF_BOARD"
                                | "SUPERVISORY_BOARD_MEMBER"
                                | "EXECUTIVE_OFFICER"
                                | "ACCOUNTANT";
                            representingRange: {
                                endDate?: string
                                | null;
                                startDate?: string | null;
                            };
                            role?: string
                            | null;
                            source?: { sourceName: string; sourceRef: string };
                            statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                        }[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean | null;
                                parent?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                parentPersonId?: string
                                | null;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                person?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                personId?: string
                                | null;
                                personRelationshipId?: string | null;
                                relationTypeCode?: string | null;
                                representingRange?: { endDate?: ...; startDate?: ... };
                                role?: string | null;
                                statusCode?: string | null;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      relationships: {
                          additionalData?: string
                          | null;
                          beneficiary?: boolean;
                          customFields?: { [key: string]: unknown } | null;
                          idCountryCode: string;
                          idNumber: string;
                          percentageOfShares?: number | null;
                          percentageOfSignature?: number | null;
                          relationTypeCode:
                              | "REPRESENTATIVE"
                              | "SHAREHOLDER"
                              | "DIRECTOR"
                              | "MEMBER_OF_BOARD"
                              | "SUPERVISORY_BOARD_MEMBER"
                              | "EXECUTIVE_OFFICER"
                              | "ACCOUNTANT";
                          representingRange: {
                              endDate?: string
                              | null;
                              startDate?: string | null;
                          };
                          role?: string
                          | null;
                          source?: { sourceName: string; sourceRef: string };
                          statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                      }[];
                  };
                  "application/json": {
                      relationships: {
                          additionalData?: string
                          | null;
                          beneficiary?: boolean;
                          customFields?: { [key: string]: unknown } | null;
                          idCountryCode: string;
                          idNumber: string;
                          percentageOfShares?: number | null;
                          percentageOfSignature?: number | null;
                          relationTypeCode:
                              | "REPRESENTATIVE"
                              | "SHAREHOLDER"
                              | "DIRECTOR"
                              | "MEMBER_OF_BOARD"
                              | "SUPERVISORY_BOARD_MEMBER"
                              | "EXECUTIVE_OFFICER"
                              | "ACCOUNTANT";
                          representingRange: {
                              endDate?: string
                              | null;
                              startDate?: string | null;
                          };
                          role?: string
                          | null;
                          source?: { sourceName: string; sourceRef: string };
                          statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                      }[];
                  };
                  "text/json": {
                      relationships: {
                          additionalData?: string
                          | null;
                          beneficiary?: boolean;
                          customFields?: { [key: string]: unknown } | null;
                          idCountryCode: string;
                          idNumber: string;
                          percentageOfShares?: number | null;
                          percentageOfSignature?: number | null;
                          relationTypeCode:
                              | "REPRESENTATIVE"
                              | "SHAREHOLDER"
                              | "DIRECTOR"
                              | "MEMBER_OF_BOARD"
                              | "SUPERVISORY_BOARD_MEMBER"
                              | "EXECUTIVE_OFFICER"
                              | "ACCOUNTANT";
                          representingRange: {
                              endDate?: string
                              | null;
                              startDate?: string | null;
                          };
                          role?: string
                          | null;
                          source?: { sourceName: string; sourceRef: string };
                          statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                      }[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean | null;
                              parent?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              parentPersonId?: string
                              | null;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              person?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              personId?: string
                              | null;
                              personRelationshipId?: string | null;
                              relationTypeCode?: string | null;
                              representingRange?: { endDate?: ...; startDate?: ... };
                              role?: string | null;
                              statusCode?: string | null;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create legal person relationships

      Add the Private person relationships to a Legal person

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    relationships: {
                        additionalData?: string | null;
                        beneficiary?: boolean;
                        customFields?: { [key: string]: unknown } | null;
                        idCountryCode: string;
                        idNumber: string;
                        percentageOfShares?: number | null;
                        percentageOfSignature?: number | null;
                        relationTypeCode:
                            | "REPRESENTATIVE"
                            | "SHAREHOLDER"
                            | "DIRECTOR"
                            | "MEMBER_OF_BOARD"
                            | "SUPERVISORY_BOARD_MEMBER"
                            | "EXECUTIVE_OFFICER"
                            | "ACCOUNTANT";
                        representingRange: {
                            endDate?: string
                            | null;
                            startDate?: string | null;
                        };
                        role?: string
                        | null;
                        source?: { sourceName: string; sourceRef: string };
                        statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                    }[];
                };
                "application/json": {
                    relationships: {
                        additionalData?: string
                        | null;
                        beneficiary?: boolean;
                        customFields?: { [key: string]: unknown } | null;
                        idCountryCode: string;
                        idNumber: string;
                        percentageOfShares?: number | null;
                        percentageOfSignature?: number | null;
                        relationTypeCode:
                            | "REPRESENTATIVE"
                            | "SHAREHOLDER"
                            | "DIRECTOR"
                            | "MEMBER_OF_BOARD"
                            | "SUPERVISORY_BOARD_MEMBER"
                            | "EXECUTIVE_OFFICER"
                            | "ACCOUNTANT";
                        representingRange: {
                            endDate?: string
                            | null;
                            startDate?: string | null;
                        };
                        role?: string
                        | null;
                        source?: { sourceName: string; sourceRef: string };
                        statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                    }[];
                };
                "text/json": {
                    relationships: {
                        additionalData?: string
                        | null;
                        beneficiary?: boolean;
                        customFields?: { [key: string]: unknown } | null;
                        idCountryCode: string;
                        idNumber: string;
                        percentageOfShares?: number | null;
                        percentageOfSignature?: number | null;
                        relationTypeCode:
                            | "REPRESENTATIVE"
                            | "SHAREHOLDER"
                            | "DIRECTOR"
                            | "MEMBER_OF_BOARD"
                            | "SUPERVISORY_BOARD_MEMBER"
                            | "EXECUTIVE_OFFICER"
                            | "ACCOUNTANT";
                        representingRange: {
                            endDate?: string
                            | null;
                            startDate?: string | null;
                        };
                        role?: string
                        | null;
                        source?: { sourceName: string; sourceRef: string };
                        statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                    }[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?:
                            | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean | null;
                                parent?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                parentPersonId?: string
                                | null;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                person?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                personId?: string
                                | null;
                                personRelationshipId?: string | null;
                                relationTypeCode?: string | null;
                                representingRange?: { endDate?: ...; startDate?: ... };
                                role?: string | null;
                                statusCode?: string | null;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?:
                          | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean | null;
                              parent?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              parentPersonId?: string
                              | null;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              person?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              personId?: string
                              | null;
                              personRelationshipId?: string | null;
                              relationTypeCode?: string | null;
                              representingRange?: { endDate?: ...; startDate?: ... };
                              role?: string | null;
                              statusCode?: string | null;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/relations/closing/{personRelationshipId}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path: { personId: string; personRelationshipId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean | null;
                                parent?: {
                                    accessRestricted?: (...) | (...) | (...) | (...);
                                    activityCode?: (...) | (...) | (...);
                                    birthDate?: (...) | (...) | (...);
                                    buildingTypeCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    creationDate?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                    forgotten?: (...) | (...) | (...) | (...);
                                    fullName?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                    idCountryCode?: (...) | (...) | (...);
                                    idNumber?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    insertedDTime?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    personGroupCodes?: (...) | (...) | (...);
                                    personId?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    source?: (...) | (...);
                                    statusCode?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tenantCode?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                parentPersonId?: string
                                | null;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                person?: {
                                    accessRestricted?: (...) | (...) | (...) | (...);
                                    activityCode?: (...) | (...) | (...);
                                    birthDate?: (...) | (...) | (...);
                                    buildingTypeCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    creationDate?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                    forgotten?: (...) | (...) | (...) | (...);
                                    fullName?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                    idCountryCode?: (...) | (...) | (...);
                                    idNumber?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    insertedDTime?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    personGroupCodes?: (...) | (...) | (...);
                                    personId?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    source?: (...) | (...);
                                    statusCode?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tenantCode?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                personId?: string
                                | null;
                                personRelationshipId?: string | null;
                                relationTypeCode?: string | null;
                                representingRange?: {
                                    endDate?: (...) | (...) | (...);
                                    startDate?: (...) | (...) | (...);
                                };
                                role?: string
                                | null;
                                statusCode?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path: { personId: string; personRelationshipId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean | null;
                              parent?: {
                                  accessRestricted?: (...) | (...) | (...) | (...);
                                  activityCode?: (...) | (...) | (...);
                                  birthDate?: (...) | (...) | (...);
                                  buildingTypeCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  creationDate?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                                  forgotten?: (...) | (...) | (...) | (...);
                                  fullName?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                                  idCountryCode?: (...) | (...) | (...);
                                  idNumber?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  insertedDTime?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  personGroupCodes?: (...) | (...) | (...);
                                  personId?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  source?: (...) | (...);
                                  statusCode?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tenantCode?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              parentPersonId?: string
                              | null;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              person?: {
                                  accessRestricted?: (...) | (...) | (...) | (...);
                                  activityCode?: (...) | (...) | (...);
                                  birthDate?: (...) | (...) | (...);
                                  buildingTypeCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  creationDate?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                                  forgotten?: (...) | (...) | (...) | (...);
                                  fullName?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                                  idCountryCode?: (...) | (...) | (...);
                                  idNumber?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  insertedDTime?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  personGroupCodes?: (...) | (...) | (...);
                                  personId?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  source?: (...) | (...);
                                  statusCode?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tenantCode?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              personId?: string
                              | null;
                              personRelationshipId?: string | null;
                              relationTypeCode?: string | null;
                              representingRange?: {
                                  endDate?: (...) | (...) | (...);
                                  startDate?: (...) | (...) | (...);
                              };
                              role?: string
                              | null;
                              statusCode?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Close person relationship

      Close the Private person relationships to a Legal person

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path: { personId: string; personRelationshipId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string; personRelationshipId: string }
          • personId: string
            ID-1030
            
          • personRelationshipId: string
            ID-1031
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            additionalData?: string | null;
                            beneficiary?: boolean | null;
                            parent?: {
                                accessRestricted?: (...) | (...) | (...) | (...);
                                activityCode?: (...) | (...) | (...);
                                birthDate?: (...) | (...) | (...);
                                buildingTypeCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                creationDate?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                                forgotten?: (...) | (...) | (...) | (...);
                                fullName?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                                idCountryCode?: (...) | (...) | (...);
                                idNumber?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                insertedDTime?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                personGroupCodes?: (...) | (...) | (...);
                                personId?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                source?: (...) | (...);
                                statusCode?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tenantCode?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            parentPersonId?: string
                            | null;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            person?: {
                                accessRestricted?: (...) | (...) | (...) | (...);
                                activityCode?: (...) | (...) | (...);
                                birthDate?: (...) | (...) | (...);
                                buildingTypeCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                creationDate?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                                forgotten?: (...) | (...) | (...) | (...);
                                fullName?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                                idCountryCode?: (...) | (...) | (...);
                                idNumber?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                insertedDTime?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                personGroupCodes?: (...) | (...) | (...);
                                personId?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                source?: (...) | (...);
                                statusCode?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tenantCode?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            personId?: string
                            | null;
                            personRelationshipId?: string | null;
                            relationTypeCode?: string | null;
                            representingRange?: {
                                endDate?: (...) | (...) | (...);
                                startDate?: (...) | (...) | (...);
                            };
                            role?: string
                            | null;
                            statusCode?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          additionalData?: string | null;
                          beneficiary?: boolean | null;
                          parent?: {
                              accessRestricted?: (...) | (...) | (...) | (...);
                              activityCode?: (...) | (...) | (...);
                              birthDate?: (...) | (...) | (...);
                              buildingTypeCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              creationDate?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                              forgotten?: (...) | (...) | (...) | (...);
                              fullName?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                              idCountryCode?: (...) | (...) | (...);
                              idNumber?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              insertedDTime?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              personGroupCodes?: (...) | (...) | (...);
                              personId?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              source?: (...) | (...);
                              statusCode?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tenantCode?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          parentPersonId?: string
                          | null;
                          percentageOfShares?: number | null;
                          percentageOfSignature?: number | null;
                          person?: {
                              accessRestricted?: (...) | (...) | (...) | (...);
                              activityCode?: (...) | (...) | (...);
                              birthDate?: (...) | (...) | (...);
                              buildingTypeCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              creationDate?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                              forgotten?: (...) | (...) | (...) | (...);
                              fullName?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                              idCountryCode?: (...) | (...) | (...);
                              idNumber?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              insertedDTime?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              personGroupCodes?: (...) | (...) | (...);
                              personId?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              source?: (...) | (...);
                              statusCode?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tenantCode?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          personId?: string
                          | null;
                          personRelationshipId?: string | null;
                          relationTypeCode?: string | null;
                          representingRange?: {
                              endDate?: (...) | (...) | (...);
                              startDate?: (...) | (...) | (...);
                          };
                          role?: string
                          | null;
                          statusCode?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/{personId}/risks": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        date?: string
                        | null;
                        riskLevelCode: string;
                        riskTypeCode: string;
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        value?: number
                        | null;
                    };
                    "application/json": {
                        date?: string
                        | null;
                        riskLevelCode: string;
                        riskTypeCode: string;
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        value?: number
                        | null;
                    };
                    "text/json": {
                        date?: string
                        | null;
                        riskLevelCode: string;
                        riskTypeCode: string;
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        value?: number
                        | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      date?: string
                      | null;
                      riskLevelCode: string;
                      riskTypeCode: string;
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      value?: number
                      | null;
                  };
                  "application/json": {
                      date?: string
                      | null;
                      riskLevelCode: string;
                      riskTypeCode: string;
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      value?: number
                      | null;
                  };
                  "text/json": {
                      date?: string
                      | null;
                      riskLevelCode: string;
                      riskTypeCode: string;
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      value?: number
                      | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create a risk for given person

      Add a customer risk profile from an AML platform before creating a virtual account

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    date?: string | null;
                    riskLevelCode: string;
                    riskTypeCode: string;
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    value?: number
                    | null;
                };
                "application/json": {
                    date?: string
                    | null;
                    riskLevelCode: string;
                    riskTypeCode: string;
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    value?: number
                    | null;
                };
                "text/json": {
                    date?: string
                    | null;
                    riskLevelCode: string;
                    riskTypeCode: string;
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    value?: number
                    | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/custom-fields/value": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query: { personId: string; sourceName: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: | {
                                fieldId: string;
                                fieldName: string;
                                fieldSetName: string;
                                fieldValue: string;
                                lookupEntityName?: string
                                | null;
                                lookupTypeCode?: string | null;
                                textValues?: (...)[] | null;
                                valueType: string;
                            }[]
                            | null;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        fieldValues: { fieldId: string; fieldValue: string }[];
                        source: { sourceName: string; sourceRef: string };
                    };
                    "application/json": {
                        fieldValues: { fieldId: string; fieldValue: string }[];
                        source: { sourceName: string; sourceRef: string };
                    };
                    "text/json": {
                        fieldValues: { fieldId: string; fieldValue: string }[];
                        source: { sourceName: string; sourceRef: string };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query: { personId: string; sourceName: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: | {
                              fieldId: string;
                              fieldName: string;
                              fieldSetName: string;
                              fieldValue: string;
                              lookupEntityName?: string
                              | null;
                              lookupTypeCode?: string | null;
                              textValues?: (...)[] | null;
                              valueType: string;
                          }[]
                          | null;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Retrieve custom field values for a person

      Retrieve the current custom field values (e.g., occupation code, IP address) for a person.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query: { personId: string; sourceName: string };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • query: { personId: string; sourceName: string }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?:
                            | {
                                fieldId: string;
                                fieldName: string;
                                fieldSetName: string;
                                fieldValue: string;
                                lookupEntityName?: string
                                | null;
                                lookupTypeCode?: string | null;
                                textValues?: (...)[] | null;
                                valueType: string;
                            }[]
                            | null;
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?:
                          | {
                              fieldId: string;
                              fieldName: string;
                              fieldSetName: string;
                              fieldValue: string;
                              lookupEntityName?: string
                              | null;
                              lookupTypeCode?: string | null;
                              textValues?: (...)[] | null;
                              valueType: string;
                          }[]
                          | null;
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      fieldValues: { fieldId: string; fieldValue: string }[];
                      source: { sourceName: string; sourceRef: string };
                  };
                  "application/json": {
                      fieldValues: { fieldId: string; fieldValue: string }[];
                      source: { sourceName: string; sourceRef: string };
                  };
                  "text/json": {
                      fieldValues: { fieldId: string; fieldValue: string }[];
                      source: { sourceName: string; sourceRef: string };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create private person occupation

      Add the occupation (SOC) code for a private person. Please refer to the full occupations list here: https://docs.zenus.io/docs/occupation-soc-list Deprecated. Use api/zv1/persons/{personId}/custom-fields/value/batch instead

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    fieldValues: { fieldId: string; fieldValue: string }[];
                    source: { sourceName: string; sourceRef: string };
                };
                "application/json": {
                    fieldValues: { fieldId: string; fieldValue: string }[];
                    source: { sourceName: string; sourceRef: string };
                };
                "text/json": {
                    fieldValues: { fieldId: string; fieldValue: string }[];
                    source: { sourceName: string; sourceRef: string };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/files": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        contractSource?: {
                            contractNumber?: string
                            | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        fileBytes: string;
                        fileName: string;
                        fileTypeCode: string;
                        parameters?: { code?: string | null; value?: string | null }[]
                        | null;
                        source: { sourceName: string; sourceRef: string };
                    };
                    "application/json": {
                        contractSource?: {
                            contractNumber?: string
                            | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        fileBytes: string;
                        fileName: string;
                        fileTypeCode: string;
                        parameters?: { code?: string | null; value?: string | null }[]
                        | null;
                        source: { sourceName: string; sourceRef: string };
                    };
                    "text/json": {
                        contractSource?: {
                            contractNumber?: string
                            | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        fileBytes: string;
                        fileName: string;
                        fileTypeCode: string;
                        parameters?: { code?: string | null; value?: string | null }[]
                        | null;
                        source: { sourceName: string; sourceRef: string };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                addedDate?: string
                                | null;
                                contractSource?: {
                                    contractNumber?: (...) | (...) | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                deleted?: boolean
                                | null;
                                fileId?: string | null;
                                fileName?: string | null;
                                fileTypeCode?: string | null;
                                parameters?: { code?: ...; value?: ... }[] | null;
                                source?: { sourceName: string; sourceRef: string };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      contractSource?: {
                          contractNumber?: string
                          | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      fileBytes: string;
                      fileName: string;
                      fileTypeCode: string;
                      parameters?: { code?: string | null; value?: string | null }[]
                      | null;
                      source: { sourceName: string; sourceRef: string };
                  };
                  "application/json": {
                      contractSource?: {
                          contractNumber?: string
                          | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      fileBytes: string;
                      fileName: string;
                      fileTypeCode: string;
                      parameters?: { code?: string | null; value?: string | null }[]
                      | null;
                      source: { sourceName: string; sourceRef: string };
                  };
                  "text/json": {
                      contractSource?: {
                          contractNumber?: string
                          | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      fileBytes: string;
                      fileName: string;
                      fileTypeCode: string;
                      parameters?: { code?: string | null; value?: string | null }[]
                      | null;
                      source: { sourceName: string; sourceRef: string };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              addedDate?: string
                              | null;
                              contractSource?: {
                                  contractNumber?: (...) | (...) | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              deleted?: boolean
                              | null;
                              fileId?: string | null;
                              fileName?: string | null;
                              fileTypeCode?: string | null;
                              parameters?: { code?: ...; value?: ... }[] | null;
                              source?: { sourceName: string; sourceRef: string };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Upload files

      Upload a person's biometric report or proof of address before creating a virtual account

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    contractSource?: {
                        contractNumber?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    fileBytes: string;
                    fileName: string;
                    fileTypeCode: string;
                    parameters?: { code?: string | null; value?: string | null }[]
                    | null;
                    source: { sourceName: string; sourceRef: string };
                };
                "application/json": {
                    contractSource?: {
                        contractNumber?: string
                        | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    fileBytes: string;
                    fileName: string;
                    fileTypeCode: string;
                    parameters?: { code?: string | null; value?: string | null }[]
                    | null;
                    source: { sourceName: string; sourceRef: string };
                };
                "text/json": {
                    contractSource?: {
                        contractNumber?: string
                        | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    fileBytes: string;
                    fileName: string;
                    fileTypeCode: string;
                    parameters?: { code?: string | null; value?: string | null }[]
                    | null;
                    source: { sourceName: string; sourceRef: string };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            addedDate?: string | null;
                            contractSource?: {
                                contractNumber?: (...) | (...) | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            deleted?: boolean
                            | null;
                            fileId?: string | null;
                            fileName?: string | null;
                            fileTypeCode?: string | null;
                            parameters?: { code?: ...; value?: ... }[] | null;
                            source?: { sourceName: string; sourceRef: string };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          addedDate?: string | null;
                          contractSource?: {
                              contractNumber?: (...) | (...) | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          deleted?: boolean
                          | null;
                          fileId?: string | null;
                          fileName?: string | null;
                          fileTypeCode?: string | null;
                          parameters?: { code?: ...; value?: ... }[] | null;
                          source?: { sourceName: string; sourceRef: string };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v1/persons/search": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query: {
                    addressTypeCode?:
                        | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                    birthDate?: string;
                    country?: string;
                    creationDateFrom?: string;
                    creationDateTo?: string;
                    firstName?: string;
                    globalSearch?: string;
                    idNumber?: string;
                    lastName?: string;
                    name?: string;
                    pageNumber: number;
                    pageSize: number;
                    personId?: string;
                    personIds?: string[];
                    personTypeCode?: "P"
                    | "L";
                    registrationDate?: string;
                    residencyCountryCode?: string;
                    sort?: { field?: string | null; order?: string | null }[];
                    statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                    statusCodeReason?: string;
                    statusCodes?: string[];
                    zip?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                values?:
                                    | {
                                        accessRestricted?: ...;
                                        activityCode?: ...;
                                        birthDate?: ...;
                                        buildingTypeCode?: ...;
                                        businessAreaCodes?: ...;
                                        businessModelDescription?: ...;
                                        counterpartySectorCode?: ...;
                                        countryOfBirth?: ...;
                                        creationDate?: ...;
                                        customerTypeCode?: ...;
                                        deathDate?: ...;
                                        dependantPersons?: ...;
                                        educationCode?: ...;
                                        email?: ...;
                                        employmentTimeCode?: ...;
                                        fixedEmploymentLength?: ...;
                                        forgotten?: ...;
                                        fullName?: ...;
                                        givenName?: ...;
                                        housingTypeCode?: ...;
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        inactivationDate?: ...;
                                        insertedDTime?: ...;
                                        intraOrgCode?: ...;
                                        language?: ...;
                                        legalForm?: ...;
                                        liquidationDate?: ...;
                                        mainPersonId?: ...;
                                        maritalStatusCode?: ...;
                                        middleName?: ...;
                                        name?: ...;
                                        nationality?: ...;
                                        pep?: ...;
                                        pepExplanation?: ...;
                                        personGroupCodes?: ...;
                                        personId?: ...;
                                        personTypeCode?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        placeOfBirth?: ...;
                                        registrationDate?: ...;
                                        residencyCountryCode?: ...;
                                        sex?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusCodeReason?: ...;
                                        surname?: ...;
                                        taxResidencyCountry?: ...;
                                        tenantCode?: ...;
                                        tradingName?: ...;
                                        usResident?: ...;
                                        webAddress?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query: {
                  addressTypeCode?:
                      | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                  birthDate?: string;
                  country?: string;
                  creationDateFrom?: string;
                  creationDateTo?: string;
                  firstName?: string;
                  globalSearch?: string;
                  idNumber?: string;
                  lastName?: string;
                  name?: string;
                  pageNumber: number;
                  pageSize: number;
                  personId?: string;
                  personIds?: string[];
                  personTypeCode?: "P"
                  | "L";
                  registrationDate?: string;
                  residencyCountryCode?: string;
                  sort?: { field?: string | null; order?: string | null }[];
                  statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                  statusCodeReason?: string;
                  statusCodes?: string[];
                  zip?: string;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              values?:
                                  | {
                                      accessRestricted?: ...;
                                      activityCode?: ...;
                                      birthDate?: ...;
                                      buildingTypeCode?: ...;
                                      businessAreaCodes?: ...;
                                      businessModelDescription?: ...;
                                      counterpartySectorCode?: ...;
                                      countryOfBirth?: ...;
                                      creationDate?: ...;
                                      customerTypeCode?: ...;
                                      deathDate?: ...;
                                      dependantPersons?: ...;
                                      educationCode?: ...;
                                      email?: ...;
                                      employmentTimeCode?: ...;
                                      fixedEmploymentLength?: ...;
                                      forgotten?: ...;
                                      fullName?: ...;
                                      givenName?: ...;
                                      housingTypeCode?: ...;
                                      idCountryCode?: ...;
                                      idNumber?: ...;
                                      inactivationDate?: ...;
                                      insertedDTime?: ...;
                                      intraOrgCode?: ...;
                                      language?: ...;
                                      legalForm?: ...;
                                      liquidationDate?: ...;
                                      mainPersonId?: ...;
                                      maritalStatusCode?: ...;
                                      middleName?: ...;
                                      name?: ...;
                                      nationality?: ...;
                                      pep?: ...;
                                      pepExplanation?: ...;
                                      personGroupCodes?: ...;
                                      personId?: ...;
                                      personTypeCode?: ...;
                                      phoneCountryCode?: ...;
                                      phoneNumber?: ...;
                                      placeOfBirth?: ...;
                                      registrationDate?: ...;
                                      residencyCountryCode?: ...;
                                      sex?: ...;
                                      source?: ...;
                                      statusCode?: ...;
                                      statusCodeReason?: ...;
                                      surname?: ...;
                                      taxResidencyCountry?: ...;
                                      tenantCode?: ...;
                                      tradingName?: ...;
                                      usResident?: ...;
                                      webAddress?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Search persons

      Finds all persons by defined criteria. Returns pageable list of persons.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query: {
                addressTypeCode?:
                    | "R"
                    | "C"
                    | "B"
                    | "D"
                    | "BILLING"
                    | "HQ_LOCATION"
                    | "PLACE_OF_BUSINESS"
                    | "SUBSIDIARY";
                birthDate?: string;
                country?: string;
                creationDateFrom?: string;
                creationDateTo?: string;
                firstName?: string;
                globalSearch?: string;
                idNumber?: string;
                lastName?: string;
                name?: string;
                pageNumber: number;
                pageSize: number;
                personId?: string;
                personIds?: string[];
                personTypeCode?: "P"
                | "L";
                registrationDate?: string;
                residencyCountryCode?: string;
                sort?: { field?: string | null; order?: string | null }[];
                statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                statusCodeReason?: string;
                statusCodes?: string[];
                zip?: string;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • query: {
              addressTypeCode?:
                  | "R"
                  | "C"
                  | "B"
                  | "D"
                  | "BILLING"
                  | "HQ_LOCATION"
                  | "PLACE_OF_BUSINESS"
                  | "SUBSIDIARY";
              birthDate?: string;
              country?: string;
              creationDateFrom?: string;
              creationDateTo?: string;
              firstName?: string;
              globalSearch?: string;
              idNumber?: string;
              lastName?: string;
              name?: string;
              pageNumber: number;
              pageSize: number;
              personId?: string;
              personIds?: string[];
              personTypeCode?: "P"
              | "L";
              registrationDate?: string;
              residencyCountryCode?: string;
              sort?: { field?: string | null; order?: string | null }[];
              statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
              statusCodeReason?: string;
              statusCodes?: string[];
              zip?: string;
          }
          • OptionaladdressTypeCode?:
                | "R"
                | "C"
                | "B"
                | "D"
                | "BILLING"
                | "HQ_LOCATION"
                | "PLACE_OF_BUSINESS"
                | "SUBSIDIARY"
          • OptionalbirthDate?: string
          • Optionalcountry?: string

            Primary identification (registration) country code

            US
            
          • OptionalcreationDateFrom?: string
          • OptionalcreationDateTo?: string
          • OptionalfirstName?: string

            First name

            Emma
            
          • OptionalglobalSearch?: string

            Fuzzy match across multiple fields (currently [name, firstName, lastName, middleName, idNumber, email])

          • OptionalidNumber?: string

            Primary identification (registration) number

            205454542955
            
          • OptionallastName?: string

            Last name

            Watson
            
          • Optionalname?: string

            Name of legal person

            Emma Watson
            
          • pageNumber: number

            Page number

          • pageSize: number

            Page size

          • OptionalpersonId?: string
          • OptionalpersonIds?: string[]

            Person ID-s

          • OptionalpersonTypeCode?: "P" | "L"
          • OptionalregistrationDate?: string

            Date of incorporation/registration (for legal entity)

          • OptionalresidencyCountryCode?: string

            Residency country code

            US
            
          • Optionalsort?: { field?: string | null; order?: string | null }[]

            Optional sorting parameters, currently only supports one element and CREATION_DATE field. Supported values for order are ASC, DESC.

          • OptionalstatusCode?: "ACTIVE" | "INACTIVE" | "PENDING"

            Status code

            ACTIVE
            
          • OptionalstatusCodeReason?: string

            Status code reason

          • OptionalstatusCodes?: string[]

            Status codes

          • Optionalzip?: string
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            values?:
                                | {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          values?:
                              | {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v2/payments/{paymentId}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { paymentId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accountId?: string
                                | null;
                                amlDeclineReason?: string | null;
                                amlMonitoringEnabled?: boolean | null;
                                autoConfirm?: boolean | null;
                                cancellationRequestStatusCode?: string | null;
                                cancelReason?: string | null;
                                cancelRefuseReason?: string | null;
                                categoryPurposeCode?: string | null;
                                chargeBearer?: string | null;
                                contractSource?: {
                                    contractNumber?: (...) | (...);
                                    sourceName?: (...) | (...);
                                    sourceRef?: (...) | (...);
                                };
                                counterpartyOriginalIban?: string
                                | null;
                                details?: string | null;
                                directionCode?: string | null;
                                endToEndId?: string | null;
                                errorCode?: string | null;
                                fees?:
                                    | {
                                        actualFeeMoney?: ...;
                                        deferredFee?: ...;
                                        estimatedFee?: ...;
                                        feeMoney?: ...;
                                        feeTypeCode?: ...;
                                    }[]
                                    | null;
                                fileImportLineNumber?: number
                                | null;
                                fxPayment?: {
                                    coverMoney?: (...) | (...);
                                    exchangeRate?: (...) | (...) | (...);
                                    fixedSide?: (...) | (...) | (...);
                                    fxQuoteRequestId?: (...) | (...) | (...);
                                    paymentMoney?: (...) | (...);
                                    reservationMoney?: (...) | (...);
                                    serviceProviderResult?: (...) | (...);
                                };
                                fxPaymentFlag?: boolean
                                | null;
                                insertedDateTime?: string | null;
                                labels?: string[] | null;
                                lastStatusRequestDate?: string | null;
                                money?: { amount?: (...) | (...); currencyCode: string };
                                paymentCancellationReasonCode?: string | null;
                                paymentId?: string | null;
                                paymentParties?:
                                    | {
                                        accountNumber?: ...;
                                        accountNumberCountryCode?: ...;
                                        accountNumberSubtype?: ...;
                                        address?: ...;
                                        financialInstitutionId?: ...;
                                        givenName?: ...;
                                        name?: ...;
                                        partyIdentification?: ...;
                                        paymentPartyId?: ...;
                                        personTypeCode?: ...;
                                        roleCode?: ...;
                                        surname?: ...;
                                        tenantCode?: ...;
                                        typeCode?: ...;
                                    }[]
                                    | null;
                                paymentSchemeElements?: | {
                                    fieldValue?: ...;
                                    fieldValueCountryCode?: ...;
                                    fieldValueSchemeTypeCode?: ...;
                                    fieldValueTypeCode?: ...;
                                    includeToMetaInfo?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                                paymentServiceProviderCode?: string
                                | null;
                                paymentTypeCode?: string | null;
                                postingDate?: string | null;
                                preferredPaymentScheme?: string | null;
                                purposeCode?: string | null;
                                referenceNumber?: string | null;
                                residencyCountryCode?: string | null;
                                returnComment?: string | null;
                                returnReason?: string | null;
                                returnSettlementDate?: string | null;
                                returnStatusCode?: string | null;
                                selectedPaymentScheme?: string | null;
                                settlementDate?: string | null;
                                settlementErrorCode?: string | null;
                                settlementPaymentScheme?: string | null;
                                settlementStatusCode?: string | null;
                                source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                statusCode?: string | null;
                                tenantCode?: string | null;
                                uetr?: string | null;
                                valueDate?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { paymentId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accountId?: string
                              | null;
                              amlDeclineReason?: string | null;
                              amlMonitoringEnabled?: boolean | null;
                              autoConfirm?: boolean | null;
                              cancellationRequestStatusCode?: string | null;
                              cancelReason?: string | null;
                              cancelRefuseReason?: string | null;
                              categoryPurposeCode?: string | null;
                              chargeBearer?: string | null;
                              contractSource?: {
                                  contractNumber?: (...) | (...);
                                  sourceName?: (...) | (...);
                                  sourceRef?: (...) | (...);
                              };
                              counterpartyOriginalIban?: string
                              | null;
                              details?: string | null;
                              directionCode?: string | null;
                              endToEndId?: string | null;
                              errorCode?: string | null;
                              fees?:
                                  | {
                                      actualFeeMoney?: ...;
                                      deferredFee?: ...;
                                      estimatedFee?: ...;
                                      feeMoney?: ...;
                                      feeTypeCode?: ...;
                                  }[]
                                  | null;
                              fileImportLineNumber?: number
                              | null;
                              fxPayment?: {
                                  coverMoney?: (...) | (...);
                                  exchangeRate?: (...) | (...) | (...);
                                  fixedSide?: (...) | (...) | (...);
                                  fxQuoteRequestId?: (...) | (...) | (...);
                                  paymentMoney?: (...) | (...);
                                  reservationMoney?: (...) | (...);
                                  serviceProviderResult?: (...) | (...);
                              };
                              fxPaymentFlag?: boolean
                              | null;
                              insertedDateTime?: string | null;
                              labels?: string[] | null;
                              lastStatusRequestDate?: string | null;
                              money?: { amount?: (...) | (...); currencyCode: string };
                              paymentCancellationReasonCode?: string | null;
                              paymentId?: string | null;
                              paymentParties?:
                                  | {
                                      accountNumber?: ...;
                                      accountNumberCountryCode?: ...;
                                      accountNumberSubtype?: ...;
                                      address?: ...;
                                      financialInstitutionId?: ...;
                                      givenName?: ...;
                                      name?: ...;
                                      partyIdentification?: ...;
                                      paymentPartyId?: ...;
                                      personTypeCode?: ...;
                                      roleCode?: ...;
                                      surname?: ...;
                                      tenantCode?: ...;
                                      typeCode?: ...;
                                  }[]
                                  | null;
                              paymentSchemeElements?: | {
                                  fieldValue?: ...;
                                  fieldValueCountryCode?: ...;
                                  fieldValueSchemeTypeCode?: ...;
                                  fieldValueTypeCode?: ...;
                                  includeToMetaInfo?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                              paymentServiceProviderCode?: string
                              | null;
                              paymentTypeCode?: string | null;
                              postingDate?: string | null;
                              preferredPaymentScheme?: string | null;
                              purposeCode?: string | null;
                              referenceNumber?: string | null;
                              residencyCountryCode?: string | null;
                              returnComment?: string | null;
                              returnReason?: string | null;
                              returnSettlementDate?: string | null;
                              returnStatusCode?: string | null;
                              selectedPaymentScheme?: string | null;
                              settlementDate?: string | null;
                              settlementErrorCode?: string | null;
                              settlementPaymentScheme?: string | null;
                              settlementStatusCode?: string | null;
                              source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                              statusCode?: string | null;
                              tenantCode?: string | null;
                              uetr?: string | null;
                              valueDate?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find Payment by Payment ID

      Finds account payment by payment ID

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { paymentId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { paymentId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accountId?: string | null;
                            amlDeclineReason?: string | null;
                            amlMonitoringEnabled?: boolean | null;
                            autoConfirm?: boolean | null;
                            cancellationRequestStatusCode?: string | null;
                            cancelReason?: string | null;
                            cancelRefuseReason?: string | null;
                            categoryPurposeCode?: string | null;
                            chargeBearer?: string | null;
                            contractSource?: {
                                contractNumber?: (...) | (...);
                                sourceName?: (...) | (...);
                                sourceRef?: (...) | (...);
                            };
                            counterpartyOriginalIban?: string
                            | null;
                            details?: string | null;
                            directionCode?: string | null;
                            endToEndId?: string | null;
                            errorCode?: string | null;
                            fees?:
                                | {
                                    actualFeeMoney?: ...;
                                    deferredFee?: ...;
                                    estimatedFee?: ...;
                                    feeMoney?: ...;
                                    feeTypeCode?: ...;
                                }[]
                                | null;
                            fileImportLineNumber?: number
                            | null;
                            fxPayment?: {
                                coverMoney?: (...) | (...);
                                exchangeRate?: (...) | (...) | (...);
                                fixedSide?: (...) | (...) | (...);
                                fxQuoteRequestId?: (...) | (...) | (...);
                                paymentMoney?: (...) | (...);
                                reservationMoney?: (...) | (...);
                                serviceProviderResult?: (...) | (...);
                            };
                            fxPaymentFlag?: boolean
                            | null;
                            insertedDateTime?: string | null;
                            labels?: string[] | null;
                            lastStatusRequestDate?: string | null;
                            money?: { amount?: (...) | (...); currencyCode: string };
                            paymentCancellationReasonCode?: string | null;
                            paymentId?: string | null;
                            paymentParties?:
                                | {
                                    accountNumber?: ...;
                                    accountNumberCountryCode?: ...;
                                    accountNumberSubtype?: ...;
                                    address?: ...;
                                    financialInstitutionId?: ...;
                                    givenName?: ...;
                                    name?: ...;
                                    partyIdentification?: ...;
                                    paymentPartyId?: ...;
                                    personTypeCode?: ...;
                                    roleCode?: ...;
                                    surname?: ...;
                                    tenantCode?: ...;
                                    typeCode?: ...;
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: ...;
                                fieldValueCountryCode?: ...;
                                fieldValueSchemeTypeCode?: ...;
                                fieldValueTypeCode?: ...;
                                includeToMetaInfo?: ...;
                                tenantCode?: ...;
                            }[]
                            | null;
                            paymentServiceProviderCode?: string
                            | null;
                            paymentTypeCode?: string | null;
                            postingDate?: string | null;
                            preferredPaymentScheme?: string | null;
                            purposeCode?: string | null;
                            referenceNumber?: string | null;
                            residencyCountryCode?: string | null;
                            returnComment?: string | null;
                            returnReason?: string | null;
                            returnSettlementDate?: string | null;
                            returnStatusCode?: string | null;
                            selectedPaymentScheme?: string | null;
                            settlementDate?: string | null;
                            settlementErrorCode?: string | null;
                            settlementPaymentScheme?: string | null;
                            settlementStatusCode?: string | null;
                            source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                            statusCode?: string | null;
                            tenantCode?: string | null;
                            uetr?: string | null;
                            valueDate?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accountId?: string | null;
                          amlDeclineReason?: string | null;
                          amlMonitoringEnabled?: boolean | null;
                          autoConfirm?: boolean | null;
                          cancellationRequestStatusCode?: string | null;
                          cancelReason?: string | null;
                          cancelRefuseReason?: string | null;
                          categoryPurposeCode?: string | null;
                          chargeBearer?: string | null;
                          contractSource?: {
                              contractNumber?: (...) | (...);
                              sourceName?: (...) | (...);
                              sourceRef?: (...) | (...);
                          };
                          counterpartyOriginalIban?: string
                          | null;
                          details?: string | null;
                          directionCode?: string | null;
                          endToEndId?: string | null;
                          errorCode?: string | null;
                          fees?:
                              | {
                                  actualFeeMoney?: ...;
                                  deferredFee?: ...;
                                  estimatedFee?: ...;
                                  feeMoney?: ...;
                                  feeTypeCode?: ...;
                              }[]
                              | null;
                          fileImportLineNumber?: number
                          | null;
                          fxPayment?: {
                              coverMoney?: (...) | (...);
                              exchangeRate?: (...) | (...) | (...);
                              fixedSide?: (...) | (...) | (...);
                              fxQuoteRequestId?: (...) | (...) | (...);
                              paymentMoney?: (...) | (...);
                              reservationMoney?: (...) | (...);
                              serviceProviderResult?: (...) | (...);
                          };
                          fxPaymentFlag?: boolean
                          | null;
                          insertedDateTime?: string | null;
                          labels?: string[] | null;
                          lastStatusRequestDate?: string | null;
                          money?: { amount?: (...) | (...); currencyCode: string };
                          paymentCancellationReasonCode?: string | null;
                          paymentId?: string | null;
                          paymentParties?:
                              | {
                                  accountNumber?: ...;
                                  accountNumberCountryCode?: ...;
                                  accountNumberSubtype?: ...;
                                  address?: ...;
                                  financialInstitutionId?: ...;
                                  givenName?: ...;
                                  name?: ...;
                                  partyIdentification?: ...;
                                  paymentPartyId?: ...;
                                  personTypeCode?: ...;
                                  roleCode?: ...;
                                  surname?: ...;
                                  tenantCode?: ...;
                                  typeCode?: ...;
                              }[]
                              | null;
                          paymentSchemeElements?: | {
                              fieldValue?: ...;
                              fieldValueCountryCode?: ...;
                              fieldValueSchemeTypeCode?: ...;
                              fieldValueTypeCode?: ...;
                              includeToMetaInfo?: ...;
                              tenantCode?: ...;
                          }[]
                          | null;
                          paymentServiceProviderCode?: string
                          | null;
                          paymentTypeCode?: string | null;
                          postingDate?: string | null;
                          preferredPaymentScheme?: string | null;
                          purposeCode?: string | null;
                          referenceNumber?: string | null;
                          residencyCountryCode?: string | null;
                          returnComment?: string | null;
                          returnReason?: string | null;
                          returnSettlementDate?: string | null;
                          returnStatusCode?: string | null;
                          selectedPaymentScheme?: string | null;
                          settlementDate?: string | null;
                          settlementErrorCode?: string | null;
                          settlementPaymentScheme?: string | null;
                          settlementStatusCode?: string | null;
                          source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                          statusCode?: string | null;
                          tenantCode?: string | null;
                          uetr?: string | null;
                          valueDate?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v2/payments/{paymentId}/return": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { paymentId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        comment?: string
                        | null;
                        returnDescription?: string | null;
                        returnReason?: string | null;
                    };
                    "application/json": {
                        comment?: string
                        | null;
                        returnDescription?: string | null;
                        returnReason?: string | null;
                    };
                    "text/json": {
                        comment?: string
                        | null;
                        returnDescription?: string | null;
                        returnReason?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { paymentId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      comment?: string
                      | null;
                      returnDescription?: string | null;
                      returnReason?: string | null;
                  };
                  "application/json": {
                      comment?: string
                      | null;
                      returnDescription?: string | null;
                      returnReason?: string | null;
                  };
                  "text/json": {
                      comment?: string
                      | null;
                      returnDescription?: string | null;
                      returnReason?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Return payment

      Makes return of the respective account payment by payment ID

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { paymentId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string

            Idempotency key

            9539eef2-ddd2-4d0e-99c6-c06b32a879cc
            
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { paymentId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    comment?: string | null;
                    returnDescription?: string | null;
                    returnReason?: string | null;
                };
                "application/json": {
                    comment?: string
                    | null;
                    returnDescription?: string | null;
                    returnReason?: string | null;
                };
                "text/json": {
                    comment?: string
                    | null;
                    returnDescription?: string | null;
                    returnReason?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v2/persons": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        addresses?: | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                        birthDate?: string
                        | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        customFields?: { [key: string]: unknown } | null;
                        documents?:
                            | {
                                documentTypeCode: | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "RESIDENCE_PERMIT";
                                expiryDate?: string
                                | null;
                                issuingCountry: string;
                                number: string;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                        email?: string
                        | null;
                        financialData?:
                            | {
                                currencyCode?: string
                                | null;
                                currentPeriodValue?: number | null;
                                description?: string | null;
                                financialDataTypeCode: string;
                                financialDataValueTypeCode:
                                    | "CURRENCY"
                                    | "NUMBER"
                                    | "NUMBER_RANGE"
                                    | "CURRENCY_RANGE";
                                nextPeriodEstimateValue?: number
                                | null;
                                period?: number | null;
                                periodRange?: { endDate?: ...; startDate?: ... };
                                valueRange?: { endValue?: ...; startValue?: ... };
                            }[]
                            | null;
                        givenName?: string
                        | null;
                        identificationNumbers?:
                            | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                            | null;
                        intraOrgCode?: string | null;
                        language?: string | null;
                        legalEntityIdentifier?: {
                            lastUpdateDate?: string | null;
                            leiCode: string;
                            localOperatingUnit: string;
                            registrationDate: string;
                        };
                        middleName?: string
                        | null;
                        name?: string | null;
                        nationality?: string | null;
                        pep?: boolean | null;
                        pepExplanation?: string | null;
                        personGroupCodes?: string[] | null;
                        personTypeCode: "P" | "L";
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        relationships?:
                            | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean;
                                customFields?: { [key: ...]: ... } | null;
                                idCountryCode: string;
                                idNumber: string;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                relationTypeCode:
                                    | "REPRESENTATIVE"
                                    | "SHAREHOLDER"
                                    | "DIRECTOR"
                                    | "MEMBER_OF_BOARD"
                                    | "SUPERVISORY_BOARD_MEMBER"
                                    | "EXECUTIVE_OFFICER"
                                    | "ACCOUNTANT";
                                representingRange: {
                                    endDate?: (...)
                                    | (...)
                                    | (...);
                                    startDate?: (...) | (...) | (...);
                                };
                                role?: string
                                | null;
                                source?: { sourceName: ...; sourceRef: ... };
                                statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                            }[]
                            | null;
                        residencyCountryCode?: string
                        | null;
                        risks?:
                            | {
                                date?: string
                                | null;
                                riskLevelCode: string;
                                riskTypeCode: string;
                                source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                                value?: number | null;
                            }[]
                            | null;
                        sex?: "M"
                        | "F"
                        | "O";
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        surname?: string
                        | null;
                        taxNumbers?:
                            | {
                                primary?: boolean
                                | null;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode?:
                                    | "TAX_IDENTIFICATION_NUMBER"
                                    | "VAT_NUMBER"
                                    | "NATIONAL_INSURANCE_NUMBER"
                                    | "TAX_CODE"
                                    | "SSN";
                            }[]
                            | null;
                        taxResidencyCountry?: string
                        | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                    };
                    "application/json": {
                        addresses?: | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                        birthDate?: string
                        | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        customFields?: { [key: string]: unknown } | null;
                        documents?:
                            | {
                                documentTypeCode: | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "RESIDENCE_PERMIT";
                                expiryDate?: string
                                | null;
                                issuingCountry: string;
                                number: string;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                        email?: string
                        | null;
                        financialData?:
                            | {
                                currencyCode?: string
                                | null;
                                currentPeriodValue?: number | null;
                                description?: string | null;
                                financialDataTypeCode: string;
                                financialDataValueTypeCode:
                                    | "CURRENCY"
                                    | "NUMBER"
                                    | "NUMBER_RANGE"
                                    | "CURRENCY_RANGE";
                                nextPeriodEstimateValue?: number
                                | null;
                                period?: number | null;
                                periodRange?: { endDate?: ...; startDate?: ... };
                                valueRange?: { endValue?: ...; startValue?: ... };
                            }[]
                            | null;
                        givenName?: string
                        | null;
                        identificationNumbers?:
                            | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                            | null;
                        intraOrgCode?: string | null;
                        language?: string | null;
                        legalEntityIdentifier?: {
                            lastUpdateDate?: string | null;
                            leiCode: string;
                            localOperatingUnit: string;
                            registrationDate: string;
                        };
                        middleName?: string
                        | null;
                        name?: string | null;
                        nationality?: string | null;
                        pep?: boolean | null;
                        pepExplanation?: string | null;
                        personGroupCodes?: string[] | null;
                        personTypeCode: "P" | "L";
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        relationships?:
                            | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean;
                                customFields?: { [key: ...]: ... } | null;
                                idCountryCode: string;
                                idNumber: string;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                relationTypeCode:
                                    | "REPRESENTATIVE"
                                    | "SHAREHOLDER"
                                    | "DIRECTOR"
                                    | "MEMBER_OF_BOARD"
                                    | "SUPERVISORY_BOARD_MEMBER"
                                    | "EXECUTIVE_OFFICER"
                                    | "ACCOUNTANT";
                                representingRange: {
                                    endDate?: (...)
                                    | (...)
                                    | (...);
                                    startDate?: (...) | (...) | (...);
                                };
                                role?: string
                                | null;
                                source?: { sourceName: ...; sourceRef: ... };
                                statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                            }[]
                            | null;
                        residencyCountryCode?: string
                        | null;
                        risks?:
                            | {
                                date?: string
                                | null;
                                riskLevelCode: string;
                                riskTypeCode: string;
                                source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                                value?: number | null;
                            }[]
                            | null;
                        sex?: "M"
                        | "F"
                        | "O";
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        surname?: string
                        | null;
                        taxNumbers?:
                            | {
                                primary?: boolean
                                | null;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode?:
                                    | "TAX_IDENTIFICATION_NUMBER"
                                    | "VAT_NUMBER"
                                    | "NATIONAL_INSURANCE_NUMBER"
                                    | "TAX_CODE"
                                    | "SSN";
                            }[]
                            | null;
                        taxResidencyCountry?: string
                        | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                    };
                    "text/json": {
                        addresses?: | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                        birthDate?: string
                        | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        countryOfBirth?: string | null;
                        customFields?: { [key: string]: unknown } | null;
                        documents?:
                            | {
                                documentTypeCode: | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "RESIDENCE_PERMIT";
                                expiryDate?: string
                                | null;
                                issuingCountry: string;
                                number: string;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                        email?: string
                        | null;
                        financialData?:
                            | {
                                currencyCode?: string
                                | null;
                                currentPeriodValue?: number | null;
                                description?: string | null;
                                financialDataTypeCode: string;
                                financialDataValueTypeCode:
                                    | "CURRENCY"
                                    | "NUMBER"
                                    | "NUMBER_RANGE"
                                    | "CURRENCY_RANGE";
                                nextPeriodEstimateValue?: number
                                | null;
                                period?: number | null;
                                periodRange?: { endDate?: ...; startDate?: ... };
                                valueRange?: { endValue?: ...; startValue?: ... };
                            }[]
                            | null;
                        givenName?: string
                        | null;
                        identificationNumbers?:
                            | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                            | null;
                        intraOrgCode?: string | null;
                        language?: string | null;
                        legalEntityIdentifier?: {
                            lastUpdateDate?: string | null;
                            leiCode: string;
                            localOperatingUnit: string;
                            registrationDate: string;
                        };
                        middleName?: string
                        | null;
                        name?: string | null;
                        nationality?: string | null;
                        pep?: boolean | null;
                        pepExplanation?: string | null;
                        personGroupCodes?: string[] | null;
                        personTypeCode: "P" | "L";
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        registrationDate?: string | null;
                        relationships?:
                            | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean;
                                customFields?: { [key: ...]: ... } | null;
                                idCountryCode: string;
                                idNumber: string;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                relationTypeCode:
                                    | "REPRESENTATIVE"
                                    | "SHAREHOLDER"
                                    | "DIRECTOR"
                                    | "MEMBER_OF_BOARD"
                                    | "SUPERVISORY_BOARD_MEMBER"
                                    | "EXECUTIVE_OFFICER"
                                    | "ACCOUNTANT";
                                representingRange: {
                                    endDate?: (...)
                                    | (...)
                                    | (...);
                                    startDate?: (...) | (...) | (...);
                                };
                                role?: string
                                | null;
                                source?: { sourceName: ...; sourceRef: ... };
                                statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                            }[]
                            | null;
                        residencyCountryCode?: string
                        | null;
                        risks?:
                            | {
                                date?: string
                                | null;
                                riskLevelCode: string;
                                riskTypeCode: string;
                                source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                                value?: number | null;
                            }[]
                            | null;
                        sex?: "M"
                        | "F"
                        | "O";
                        source?: {
                            sourceLink?: string | null;
                            sourceName: string;
                            sourceRef: string;
                        };
                        surname?: string
                        | null;
                        taxNumbers?:
                            | {
                                primary?: boolean
                                | null;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode?:
                                    | "TAX_IDENTIFICATION_NUMBER"
                                    | "VAT_NUMBER"
                                    | "NATIONAL_INSURANCE_NUMBER"
                                    | "TAX_CODE"
                                    | "SSN";
                            }[]
                            | null;
                        taxResidencyCountry?: string
                        | null;
                        usResident?: boolean | null;
                        webAddress?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                additionalContacts?:
                                    | {
                                        additionalContactId?: ...;
                                        contactTypeCode?: ...;
                                        description?: ...;
                                        email?: ...;
                                        personId?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        preferredMethodOfContact?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                additionalInfo?: {
                                    birthDate?: (...)
                                    | (...)
                                    | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                addresses?: | {
                                    addressId?: ...;
                                    addressTypeCode?: ...;
                                    apartmentNumber?: ...;
                                    buildingName?: ...;
                                    buildingNumber?: ...;
                                    cityCounty?: ...;
                                    countryCode?: ...;
                                    department?: ...;
                                    district?: ...;
                                    floor?: ...;
                                    moveInDate?: ...;
                                    personId?: ...;
                                    postBox?: ...;
                                    stateRegion?: ...;
                                    street1?: ...;
                                    street2?: ...;
                                    streetName?: ...;
                                    structured?: ...;
                                    subDepartment?: ...;
                                    townLocationName?: ...;
                                    validityRange?: ...;
                                    zip?: ...;
                                }[]
                                | null;
                                creationDate?: string
                                | null;
                                documents?:
                                    | {
                                        docuId?: ...;
                                        documentTypeCode?: ...;
                                        expiryDate?: ...;
                                        issuingCountry?: ...;
                                        number?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                forgotten?: boolean
                                | null;
                                fullName?: string | null;
                                home?: {
                                    buildingTypeCode?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                };
                                identificationNumbers?: | {
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    idNumberId?: ...;
                                    personId?: ...;
                                    primary?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                legalForm?: string
                                | null;
                                mainPersonId?: string | null;
                                personalInfo?: {
                                    dependantPersons?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                };
                                personGroupCodes?: | {
                                    personGroupCode: ...;
                                    personGroupId?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                personId?: string
                                | null;
                                relationships?:
                                    | {
                                        additionalData?: ...;
                                        beneficiary?: ...;
                                        parent?: ...;
                                        parentPersonId?: ...;
                                        percentageOfShares?: ...;
                                        percentageOfSignature?: ...;
                                        person?: ...;
                                        personId?: ...;
                                        personRelationshipId?: ...;
                                        relationTypeCode?: ...;
                                        representingRange?: ...;
                                        role?: ...;
                                        statusCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                source?: {
                                    sourceLink?: (...)
                                    | (...)
                                    | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                statusCode?: string
                                | null;
                                taxNumbers?:
                                    | {
                                        personId?: ...;
                                        primary?: ...;
                                        taxCountryCode?: ...;
                                        taxNumber?: ...;
                                        taxNumberId?: ...;
                                        taxNumberTypeCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                tenantCode?: string
                                | null;
                                work?: {
                                    activityCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      addresses?: | {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          moveInDate?: string
                          | null;
                          stateRegion?: string | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[]
                      | null;
                      birthDate?: string
                      | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      customFields?: { [key: string]: unknown } | null;
                      documents?:
                          | {
                              documentTypeCode: | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "RESIDENCE_PERMIT";
                              expiryDate?: string
                              | null;
                              issuingCountry: string;
                              number: string;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                      email?: string
                      | null;
                      financialData?:
                          | {
                              currencyCode?: string
                              | null;
                              currentPeriodValue?: number | null;
                              description?: string | null;
                              financialDataTypeCode: string;
                              financialDataValueTypeCode:
                                  | "CURRENCY"
                                  | "NUMBER"
                                  | "NUMBER_RANGE"
                                  | "CURRENCY_RANGE";
                              nextPeriodEstimateValue?: number
                              | null;
                              period?: number | null;
                              periodRange?: { endDate?: ...; startDate?: ... };
                              valueRange?: { endValue?: ...; startValue?: ... };
                          }[]
                          | null;
                      givenName?: string
                      | null;
                      identificationNumbers?:
                          | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                          | null;
                      intraOrgCode?: string | null;
                      language?: string | null;
                      legalEntityIdentifier?: {
                          lastUpdateDate?: string | null;
                          leiCode: string;
                          localOperatingUnit: string;
                          registrationDate: string;
                      };
                      middleName?: string
                      | null;
                      name?: string | null;
                      nationality?: string | null;
                      pep?: boolean | null;
                      pepExplanation?: string | null;
                      personGroupCodes?: string[] | null;
                      personTypeCode: "P" | "L";
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      relationships?:
                          | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean;
                              customFields?: { [key: ...]: ... } | null;
                              idCountryCode: string;
                              idNumber: string;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              relationTypeCode:
                                  | "REPRESENTATIVE"
                                  | "SHAREHOLDER"
                                  | "DIRECTOR"
                                  | "MEMBER_OF_BOARD"
                                  | "SUPERVISORY_BOARD_MEMBER"
                                  | "EXECUTIVE_OFFICER"
                                  | "ACCOUNTANT";
                              representingRange: {
                                  endDate?: (...)
                                  | (...)
                                  | (...);
                                  startDate?: (...) | (...) | (...);
                              };
                              role?: string
                              | null;
                              source?: { sourceName: ...; sourceRef: ... };
                              statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                          }[]
                          | null;
                      residencyCountryCode?: string
                      | null;
                      risks?:
                          | {
                              date?: string
                              | null;
                              riskLevelCode: string;
                              riskTypeCode: string;
                              source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                              value?: number | null;
                          }[]
                          | null;
                      sex?: "M"
                      | "F"
                      | "O";
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      surname?: string
                      | null;
                      taxNumbers?:
                          | {
                              primary?: boolean
                              | null;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode?:
                                  | "TAX_IDENTIFICATION_NUMBER"
                                  | "VAT_NUMBER"
                                  | "NATIONAL_INSURANCE_NUMBER"
                                  | "TAX_CODE"
                                  | "SSN";
                          }[]
                          | null;
                      taxResidencyCountry?: string
                      | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                  };
                  "application/json": {
                      addresses?: | {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          moveInDate?: string
                          | null;
                          stateRegion?: string | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[]
                      | null;
                      birthDate?: string
                      | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      customFields?: { [key: string]: unknown } | null;
                      documents?:
                          | {
                              documentTypeCode: | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "RESIDENCE_PERMIT";
                              expiryDate?: string
                              | null;
                              issuingCountry: string;
                              number: string;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                      email?: string
                      | null;
                      financialData?:
                          | {
                              currencyCode?: string
                              | null;
                              currentPeriodValue?: number | null;
                              description?: string | null;
                              financialDataTypeCode: string;
                              financialDataValueTypeCode:
                                  | "CURRENCY"
                                  | "NUMBER"
                                  | "NUMBER_RANGE"
                                  | "CURRENCY_RANGE";
                              nextPeriodEstimateValue?: number
                              | null;
                              period?: number | null;
                              periodRange?: { endDate?: ...; startDate?: ... };
                              valueRange?: { endValue?: ...; startValue?: ... };
                          }[]
                          | null;
                      givenName?: string
                      | null;
                      identificationNumbers?:
                          | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                          | null;
                      intraOrgCode?: string | null;
                      language?: string | null;
                      legalEntityIdentifier?: {
                          lastUpdateDate?: string | null;
                          leiCode: string;
                          localOperatingUnit: string;
                          registrationDate: string;
                      };
                      middleName?: string
                      | null;
                      name?: string | null;
                      nationality?: string | null;
                      pep?: boolean | null;
                      pepExplanation?: string | null;
                      personGroupCodes?: string[] | null;
                      personTypeCode: "P" | "L";
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      relationships?:
                          | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean;
                              customFields?: { [key: ...]: ... } | null;
                              idCountryCode: string;
                              idNumber: string;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              relationTypeCode:
                                  | "REPRESENTATIVE"
                                  | "SHAREHOLDER"
                                  | "DIRECTOR"
                                  | "MEMBER_OF_BOARD"
                                  | "SUPERVISORY_BOARD_MEMBER"
                                  | "EXECUTIVE_OFFICER"
                                  | "ACCOUNTANT";
                              representingRange: {
                                  endDate?: (...)
                                  | (...)
                                  | (...);
                                  startDate?: (...) | (...) | (...);
                              };
                              role?: string
                              | null;
                              source?: { sourceName: ...; sourceRef: ... };
                              statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                          }[]
                          | null;
                      residencyCountryCode?: string
                      | null;
                      risks?:
                          | {
                              date?: string
                              | null;
                              riskLevelCode: string;
                              riskTypeCode: string;
                              source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                              value?: number | null;
                          }[]
                          | null;
                      sex?: "M"
                      | "F"
                      | "O";
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      surname?: string
                      | null;
                      taxNumbers?:
                          | {
                              primary?: boolean
                              | null;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode?:
                                  | "TAX_IDENTIFICATION_NUMBER"
                                  | "VAT_NUMBER"
                                  | "NATIONAL_INSURANCE_NUMBER"
                                  | "TAX_CODE"
                                  | "SSN";
                          }[]
                          | null;
                      taxResidencyCountry?: string
                      | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                  };
                  "text/json": {
                      addresses?: | {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          moveInDate?: string
                          | null;
                          stateRegion?: string | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[]
                      | null;
                      birthDate?: string
                      | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      countryOfBirth?: string | null;
                      customFields?: { [key: string]: unknown } | null;
                      documents?:
                          | {
                              documentTypeCode: | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "RESIDENCE_PERMIT";
                              expiryDate?: string
                              | null;
                              issuingCountry: string;
                              number: string;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                      email?: string
                      | null;
                      financialData?:
                          | {
                              currencyCode?: string
                              | null;
                              currentPeriodValue?: number | null;
                              description?: string | null;
                              financialDataTypeCode: string;
                              financialDataValueTypeCode:
                                  | "CURRENCY"
                                  | "NUMBER"
                                  | "NUMBER_RANGE"
                                  | "CURRENCY_RANGE";
                              nextPeriodEstimateValue?: number
                              | null;
                              period?: number | null;
                              periodRange?: { endDate?: ...; startDate?: ... };
                              valueRange?: { endValue?: ...; startValue?: ... };
                          }[]
                          | null;
                      givenName?: string
                      | null;
                      identificationNumbers?:
                          | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                          | null;
                      intraOrgCode?: string | null;
                      language?: string | null;
                      legalEntityIdentifier?: {
                          lastUpdateDate?: string | null;
                          leiCode: string;
                          localOperatingUnit: string;
                          registrationDate: string;
                      };
                      middleName?: string
                      | null;
                      name?: string | null;
                      nationality?: string | null;
                      pep?: boolean | null;
                      pepExplanation?: string | null;
                      personGroupCodes?: string[] | null;
                      personTypeCode: "P" | "L";
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      registrationDate?: string | null;
                      relationships?:
                          | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean;
                              customFields?: { [key: ...]: ... } | null;
                              idCountryCode: string;
                              idNumber: string;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              relationTypeCode:
                                  | "REPRESENTATIVE"
                                  | "SHAREHOLDER"
                                  | "DIRECTOR"
                                  | "MEMBER_OF_BOARD"
                                  | "SUPERVISORY_BOARD_MEMBER"
                                  | "EXECUTIVE_OFFICER"
                                  | "ACCOUNTANT";
                              representingRange: {
                                  endDate?: (...)
                                  | (...)
                                  | (...);
                                  startDate?: (...) | (...) | (...);
                              };
                              role?: string
                              | null;
                              source?: { sourceName: ...; sourceRef: ... };
                              statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                          }[]
                          | null;
                      residencyCountryCode?: string
                      | null;
                      risks?:
                          | {
                              date?: string
                              | null;
                              riskLevelCode: string;
                              riskTypeCode: string;
                              source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                              value?: number | null;
                          }[]
                          | null;
                      sex?: "M"
                      | "F"
                      | "O";
                      source?: {
                          sourceLink?: string | null;
                          sourceName: string;
                          sourceRef: string;
                      };
                      surname?: string
                      | null;
                      taxNumbers?:
                          | {
                              primary?: boolean
                              | null;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode?:
                                  | "TAX_IDENTIFICATION_NUMBER"
                                  | "VAT_NUMBER"
                                  | "NATIONAL_INSURANCE_NUMBER"
                                  | "TAX_CODE"
                                  | "SSN";
                          }[]
                          | null;
                      taxResidencyCountry?: string
                      | null;
                      usResident?: boolean | null;
                      webAddress?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              additionalContacts?:
                                  | {
                                      additionalContactId?: ...;
                                      contactTypeCode?: ...;
                                      description?: ...;
                                      email?: ...;
                                      personId?: ...;
                                      phoneCountryCode?: ...;
                                      phoneNumber?: ...;
                                      preferredMethodOfContact?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              additionalInfo?: {
                                  birthDate?: (...)
                                  | (...)
                                  | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              addresses?: | {
                                  addressId?: ...;
                                  addressTypeCode?: ...;
                                  apartmentNumber?: ...;
                                  buildingName?: ...;
                                  buildingNumber?: ...;
                                  cityCounty?: ...;
                                  countryCode?: ...;
                                  department?: ...;
                                  district?: ...;
                                  floor?: ...;
                                  moveInDate?: ...;
                                  personId?: ...;
                                  postBox?: ...;
                                  stateRegion?: ...;
                                  street1?: ...;
                                  street2?: ...;
                                  streetName?: ...;
                                  structured?: ...;
                                  subDepartment?: ...;
                                  townLocationName?: ...;
                                  validityRange?: ...;
                                  zip?: ...;
                              }[]
                              | null;
                              creationDate?: string
                              | null;
                              documents?:
                                  | {
                                      docuId?: ...;
                                      documentTypeCode?: ...;
                                      expiryDate?: ...;
                                      issuingCountry?: ...;
                                      number?: ...;
                                      personId?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              forgotten?: boolean
                              | null;
                              fullName?: string | null;
                              home?: {
                                  buildingTypeCode?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                              };
                              identificationNumbers?: | {
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  idNumberId?: ...;
                                  personId?: ...;
                                  primary?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              legalForm?: string
                              | null;
                              mainPersonId?: string | null;
                              personalInfo?: {
                                  dependantPersons?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                              };
                              personGroupCodes?: | {
                                  personGroupCode: ...;
                                  personGroupId?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              personId?: string
                              | null;
                              relationships?:
                                  | {
                                      additionalData?: ...;
                                      beneficiary?: ...;
                                      parent?: ...;
                                      parentPersonId?: ...;
                                      percentageOfShares?: ...;
                                      percentageOfSignature?: ...;
                                      person?: ...;
                                      personId?: ...;
                                      personRelationshipId?: ...;
                                      relationTypeCode?: ...;
                                      representingRange?: ...;
                                      role?: ...;
                                      statusCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              source?: {
                                  sourceLink?: (...)
                                  | (...)
                                  | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              statusCode?: string
                              | null;
                              taxNumbers?:
                                  | {
                                      personId?: ...;
                                      primary?: ...;
                                      taxCountryCode?: ...;
                                      taxNumber?: ...;
                                      taxNumberId?: ...;
                                      taxNumberTypeCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              tenantCode?: string
                              | null;
                              work?: {
                                  activityCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create person

      Creates a new private or legal person

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    addresses?:
                        | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                    birthDate?: string
                    | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    customFields?: { [key: string]: unknown } | null;
                    documents?:
                        | {
                            documentTypeCode: | "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD"
                            | "RESIDENCE_PERMIT";
                            expiryDate?: string
                            | null;
                            issuingCountry: string;
                            number: string;
                            validityRange?: { endTime?: ...; startTime?: ... };
                        }[]
                        | null;
                    email?: string
                    | null;
                    financialData?:
                        | {
                            currencyCode?: string
                            | null;
                            currentPeriodValue?: number | null;
                            description?: string | null;
                            financialDataTypeCode: string;
                            financialDataValueTypeCode:
                                | "CURRENCY"
                                | "NUMBER"
                                | "NUMBER_RANGE"
                                | "CURRENCY_RANGE";
                            nextPeriodEstimateValue?: number
                            | null;
                            period?: number | null;
                            periodRange?: { endDate?: ...; startDate?: ... };
                            valueRange?: { endValue?: ...; startValue?: ... };
                        }[]
                        | null;
                    givenName?: string
                    | null;
                    identificationNumbers?:
                        | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                        | null;
                    intraOrgCode?: string | null;
                    language?: string | null;
                    legalEntityIdentifier?: {
                        lastUpdateDate?: string | null;
                        leiCode: string;
                        localOperatingUnit: string;
                        registrationDate: string;
                    };
                    middleName?: string
                    | null;
                    name?: string | null;
                    nationality?: string | null;
                    pep?: boolean | null;
                    pepExplanation?: string | null;
                    personGroupCodes?: string[] | null;
                    personTypeCode: "P" | "L";
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    relationships?:
                        | {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            customFields?: { [key: ...]: ... } | null;
                            idCountryCode: string;
                            idNumber: string;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            relationTypeCode:
                                | "REPRESENTATIVE"
                                | "SHAREHOLDER"
                                | "DIRECTOR"
                                | "MEMBER_OF_BOARD"
                                | "SUPERVISORY_BOARD_MEMBER"
                                | "EXECUTIVE_OFFICER"
                                | "ACCOUNTANT";
                            representingRange: {
                                endDate?: (...)
                                | (...)
                                | (...);
                                startDate?: (...) | (...) | (...);
                            };
                            role?: string
                            | null;
                            source?: { sourceName: ...; sourceRef: ... };
                            statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                        }[]
                        | null;
                    residencyCountryCode?: string
                    | null;
                    risks?:
                        | {
                            date?: string
                            | null;
                            riskLevelCode: string;
                            riskTypeCode: string;
                            source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                            value?: number | null;
                        }[]
                        | null;
                    sex?: "M"
                    | "F"
                    | "O";
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    surname?: string
                    | null;
                    taxNumbers?:
                        | {
                            primary?: boolean
                            | null;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode?:
                                | "TAX_IDENTIFICATION_NUMBER"
                                | "VAT_NUMBER"
                                | "NATIONAL_INSURANCE_NUMBER"
                                | "TAX_CODE"
                                | "SSN";
                        }[]
                        | null;
                    taxResidencyCountry?: string
                    | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                };
                "application/json": {
                    addresses?: | {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[]
                    | null;
                    birthDate?: string
                    | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    customFields?: { [key: string]: unknown } | null;
                    documents?:
                        | {
                            documentTypeCode: | "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD"
                            | "RESIDENCE_PERMIT";
                            expiryDate?: string
                            | null;
                            issuingCountry: string;
                            number: string;
                            validityRange?: { endTime?: ...; startTime?: ... };
                        }[]
                        | null;
                    email?: string
                    | null;
                    financialData?:
                        | {
                            currencyCode?: string
                            | null;
                            currentPeriodValue?: number | null;
                            description?: string | null;
                            financialDataTypeCode: string;
                            financialDataValueTypeCode:
                                | "CURRENCY"
                                | "NUMBER"
                                | "NUMBER_RANGE"
                                | "CURRENCY_RANGE";
                            nextPeriodEstimateValue?: number
                            | null;
                            period?: number | null;
                            periodRange?: { endDate?: ...; startDate?: ... };
                            valueRange?: { endValue?: ...; startValue?: ... };
                        }[]
                        | null;
                    givenName?: string
                    | null;
                    identificationNumbers?:
                        | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                        | null;
                    intraOrgCode?: string | null;
                    language?: string | null;
                    legalEntityIdentifier?: {
                        lastUpdateDate?: string | null;
                        leiCode: string;
                        localOperatingUnit: string;
                        registrationDate: string;
                    };
                    middleName?: string
                    | null;
                    name?: string | null;
                    nationality?: string | null;
                    pep?: boolean | null;
                    pepExplanation?: string | null;
                    personGroupCodes?: string[] | null;
                    personTypeCode: "P" | "L";
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    relationships?:
                        | {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            customFields?: { [key: ...]: ... } | null;
                            idCountryCode: string;
                            idNumber: string;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            relationTypeCode:
                                | "REPRESENTATIVE"
                                | "SHAREHOLDER"
                                | "DIRECTOR"
                                | "MEMBER_OF_BOARD"
                                | "SUPERVISORY_BOARD_MEMBER"
                                | "EXECUTIVE_OFFICER"
                                | "ACCOUNTANT";
                            representingRange: {
                                endDate?: (...)
                                | (...)
                                | (...);
                                startDate?: (...) | (...) | (...);
                            };
                            role?: string
                            | null;
                            source?: { sourceName: ...; sourceRef: ... };
                            statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                        }[]
                        | null;
                    residencyCountryCode?: string
                    | null;
                    risks?:
                        | {
                            date?: string
                            | null;
                            riskLevelCode: string;
                            riskTypeCode: string;
                            source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                            value?: number | null;
                        }[]
                        | null;
                    sex?: "M"
                    | "F"
                    | "O";
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    surname?: string
                    | null;
                    taxNumbers?:
                        | {
                            primary?: boolean
                            | null;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode?:
                                | "TAX_IDENTIFICATION_NUMBER"
                                | "VAT_NUMBER"
                                | "NATIONAL_INSURANCE_NUMBER"
                                | "TAX_CODE"
                                | "SSN";
                        }[]
                        | null;
                    taxResidencyCountry?: string
                    | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                };
                "text/json": {
                    addresses?: | {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[]
                    | null;
                    birthDate?: string
                    | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    countryOfBirth?: string | null;
                    customFields?: { [key: string]: unknown } | null;
                    documents?:
                        | {
                            documentTypeCode: | "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD"
                            | "RESIDENCE_PERMIT";
                            expiryDate?: string
                            | null;
                            issuingCountry: string;
                            number: string;
                            validityRange?: { endTime?: ...; startTime?: ... };
                        }[]
                        | null;
                    email?: string
                    | null;
                    financialData?:
                        | {
                            currencyCode?: string
                            | null;
                            currentPeriodValue?: number | null;
                            description?: string | null;
                            financialDataTypeCode: string;
                            financialDataValueTypeCode:
                                | "CURRENCY"
                                | "NUMBER"
                                | "NUMBER_RANGE"
                                | "CURRENCY_RANGE";
                            nextPeriodEstimateValue?: number
                            | null;
                            period?: number | null;
                            periodRange?: { endDate?: ...; startDate?: ... };
                            valueRange?: { endValue?: ...; startValue?: ... };
                        }[]
                        | null;
                    givenName?: string
                    | null;
                    identificationNumbers?:
                        | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                        | null;
                    intraOrgCode?: string | null;
                    language?: string | null;
                    legalEntityIdentifier?: {
                        lastUpdateDate?: string | null;
                        leiCode: string;
                        localOperatingUnit: string;
                        registrationDate: string;
                    };
                    middleName?: string
                    | null;
                    name?: string | null;
                    nationality?: string | null;
                    pep?: boolean | null;
                    pepExplanation?: string | null;
                    personGroupCodes?: string[] | null;
                    personTypeCode: "P" | "L";
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    registrationDate?: string | null;
                    relationships?:
                        | {
                            additionalData?: string
                            | null;
                            beneficiary?: boolean;
                            customFields?: { [key: ...]: ... } | null;
                            idCountryCode: string;
                            idNumber: string;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            relationTypeCode:
                                | "REPRESENTATIVE"
                                | "SHAREHOLDER"
                                | "DIRECTOR"
                                | "MEMBER_OF_BOARD"
                                | "SUPERVISORY_BOARD_MEMBER"
                                | "EXECUTIVE_OFFICER"
                                | "ACCOUNTANT";
                            representingRange: {
                                endDate?: (...)
                                | (...)
                                | (...);
                                startDate?: (...) | (...) | (...);
                            };
                            role?: string
                            | null;
                            source?: { sourceName: ...; sourceRef: ... };
                            statusCode: "ACTIVE" | "INACTIVE" | "CLOSED";
                        }[]
                        | null;
                    residencyCountryCode?: string
                    | null;
                    risks?:
                        | {
                            date?: string
                            | null;
                            riskLevelCode: string;
                            riskTypeCode: string;
                            source?: { sourceLink?: ...; sourceName: ...; sourceRef: ... };
                            value?: number | null;
                        }[]
                        | null;
                    sex?: "M"
                    | "F"
                    | "O";
                    source?: {
                        sourceLink?: string | null;
                        sourceName: string;
                        sourceRef: string;
                    };
                    surname?: string
                    | null;
                    taxNumbers?:
                        | {
                            primary?: boolean
                            | null;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode?:
                                | "TAX_IDENTIFICATION_NUMBER"
                                | "VAT_NUMBER"
                                | "NATIONAL_INSURANCE_NUMBER"
                                | "TAX_CODE"
                                | "SSN";
                        }[]
                        | null;
                    taxResidencyCountry?: string
                    | null;
                    usResident?: boolean | null;
                    webAddress?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            additionalContacts?:
                                | {
                                    additionalContactId?: ...;
                                    contactTypeCode?: ...;
                                    description?: ...;
                                    email?: ...;
                                    personId?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    preferredMethodOfContact?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            additionalInfo?: {
                                birthDate?: (...)
                                | (...)
                                | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            addresses?: | {
                                addressId?: ...;
                                addressTypeCode?: ...;
                                apartmentNumber?: ...;
                                buildingName?: ...;
                                buildingNumber?: ...;
                                cityCounty?: ...;
                                countryCode?: ...;
                                department?: ...;
                                district?: ...;
                                floor?: ...;
                                moveInDate?: ...;
                                personId?: ...;
                                postBox?: ...;
                                stateRegion?: ...;
                                street1?: ...;
                                street2?: ...;
                                streetName?: ...;
                                structured?: ...;
                                subDepartment?: ...;
                                townLocationName?: ...;
                                validityRange?: ...;
                                zip?: ...;
                            }[]
                            | null;
                            creationDate?: string
                            | null;
                            documents?:
                                | {
                                    docuId?: ...;
                                    documentTypeCode?: ...;
                                    expiryDate?: ...;
                                    issuingCountry?: ...;
                                    number?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            forgotten?: boolean
                            | null;
                            fullName?: string | null;
                            home?: {
                                buildingTypeCode?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                            };
                            identificationNumbers?: | {
                                idCountryCode?: ...;
                                idNumber?: ...;
                                idNumberId?: ...;
                                personId?: ...;
                                primary?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            legalForm?: string
                            | null;
                            mainPersonId?: string | null;
                            personalInfo?: {
                                dependantPersons?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                            };
                            personGroupCodes?: | {
                                personGroupCode: ...;
                                personGroupId?: ...;
                                personId?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            personId?: string
                            | null;
                            relationships?:
                                | {
                                    additionalData?: ...;
                                    beneficiary?: ...;
                                    parent?: ...;
                                    parentPersonId?: ...;
                                    percentageOfShares?: ...;
                                    percentageOfSignature?: ...;
                                    person?: ...;
                                    personId?: ...;
                                    personRelationshipId?: ...;
                                    relationTypeCode?: ...;
                                    representingRange?: ...;
                                    role?: ...;
                                    statusCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            source?: {
                                sourceLink?: (...)
                                | (...)
                                | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCode?: string
                            | null;
                            taxNumbers?:
                                | {
                                    personId?: ...;
                                    primary?: ...;
                                    taxCountryCode?: ...;
                                    taxNumber?: ...;
                                    taxNumberId?: ...;
                                    taxNumberTypeCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            tenantCode?: string
                            | null;
                            work?: {
                                activityCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          additionalContacts?:
                              | {
                                  additionalContactId?: ...;
                                  contactTypeCode?: ...;
                                  description?: ...;
                                  email?: ...;
                                  personId?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  preferredMethodOfContact?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          additionalInfo?: {
                              birthDate?: (...)
                              | (...)
                              | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          addresses?: | {
                              addressId?: ...;
                              addressTypeCode?: ...;
                              apartmentNumber?: ...;
                              buildingName?: ...;
                              buildingNumber?: ...;
                              cityCounty?: ...;
                              countryCode?: ...;
                              department?: ...;
                              district?: ...;
                              floor?: ...;
                              moveInDate?: ...;
                              personId?: ...;
                              postBox?: ...;
                              stateRegion?: ...;
                              street1?: ...;
                              street2?: ...;
                              streetName?: ...;
                              structured?: ...;
                              subDepartment?: ...;
                              townLocationName?: ...;
                              validityRange?: ...;
                              zip?: ...;
                          }[]
                          | null;
                          creationDate?: string
                          | null;
                          documents?:
                              | {
                                  docuId?: ...;
                                  documentTypeCode?: ...;
                                  expiryDate?: ...;
                                  issuingCountry?: ...;
                                  number?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          forgotten?: boolean
                          | null;
                          fullName?: string | null;
                          home?: {
                              buildingTypeCode?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                          };
                          identificationNumbers?: | {
                              idCountryCode?: ...;
                              idNumber?: ...;
                              idNumberId?: ...;
                              personId?: ...;
                              primary?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          legalForm?: string
                          | null;
                          mainPersonId?: string | null;
                          personalInfo?: {
                              dependantPersons?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                          };
                          personGroupCodes?: | {
                              personGroupCode: ...;
                              personGroupId?: ...;
                              personId?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          personId?: string
                          | null;
                          relationships?:
                              | {
                                  additionalData?: ...;
                                  beneficiary?: ...;
                                  parent?: ...;
                                  parentPersonId?: ...;
                                  percentageOfShares?: ...;
                                  percentageOfSignature?: ...;
                                  person?: ...;
                                  personId?: ...;
                                  personRelationshipId?: ...;
                                  relationTypeCode?: ...;
                                  representingRange?: ...;
                                  role?: ...;
                                  statusCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          source?: {
                              sourceLink?: (...)
                              | (...)
                              | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          statusCode?: string
                          | null;
                          taxNumbers?:
                              | {
                                  personId?: ...;
                                  primary?: ...;
                                  taxCountryCode?: ...;
                                  taxNumber?: ...;
                                  taxNumberId?: ...;
                                  taxNumberTypeCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          tenantCode?: string
                          | null;
                          work?: {
                              activityCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v2/persons/{personId}/addresses": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    };
                    "application/json": {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    };
                    "text/json": {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                addressId?: string
                                | null;
                                addressTypeCode?: string | null;
                                apartmentNumber?: string | null;
                                buildingName?: string | null;
                                buildingNumber?: string | null;
                                cityCounty?: string | null;
                                countryCode?: string | null;
                                department?: string | null;
                                district?: string | null;
                                floor?: string | null;
                                moveInDate?: string | null;
                                personId?: string | null;
                                postBox?: string | null;
                                stateRegion?: string | null;
                                street1?: string | null;
                                street2?: string | null;
                                streetName?: string | null;
                                structured?: boolean | null;
                                subDepartment?: string | null;
                                townLocationName?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                                zip?: string
                                | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      addressTypeCode: | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                      cityCounty: string;
                      countryCode: string;
                      moveInDate?: string
                      | null;
                      stateRegion?: string | null;
                      street1: string;
                      street2?: string | null;
                      zip: string;
                  };
                  "application/json": {
                      addressTypeCode: | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                      cityCounty: string;
                      countryCode: string;
                      moveInDate?: string
                      | null;
                      stateRegion?: string | null;
                      street1: string;
                      street2?: string | null;
                      zip: string;
                  };
                  "text/json": {
                      addressTypeCode: | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                      cityCounty: string;
                      countryCode: string;
                      moveInDate?: string
                      | null;
                      stateRegion?: string | null;
                      street1: string;
                      street2?: string | null;
                      zip: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              addressId?: string
                              | null;
                              addressTypeCode?: string | null;
                              apartmentNumber?: string | null;
                              buildingName?: string | null;
                              buildingNumber?: string | null;
                              cityCounty?: string | null;
                              countryCode?: string | null;
                              department?: string | null;
                              district?: string | null;
                              floor?: string | null;
                              moveInDate?: string | null;
                              personId?: string | null;
                              postBox?: string | null;
                              stateRegion?: string | null;
                              street1?: string | null;
                              street2?: string | null;
                              streetName?: string | null;
                              structured?: boolean | null;
                              subDepartment?: string | null;
                              townLocationName?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                              zip?: string
                              | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create person address

      Adds a new address to a person

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    addressTypeCode:
                        | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                    cityCounty: string;
                    countryCode: string;
                    moveInDate?: string
                    | null;
                    stateRegion?: string | null;
                    street1: string;
                    street2?: string | null;
                    zip: string;
                };
                "application/json": {
                    addressTypeCode: | "R"
                    | "C"
                    | "B"
                    | "D"
                    | "BILLING"
                    | "HQ_LOCATION"
                    | "PLACE_OF_BUSINESS"
                    | "SUBSIDIARY";
                    cityCounty: string;
                    countryCode: string;
                    moveInDate?: string
                    | null;
                    stateRegion?: string | null;
                    street1: string;
                    street2?: string | null;
                    zip: string;
                };
                "text/json": {
                    addressTypeCode: | "R"
                    | "C"
                    | "B"
                    | "D"
                    | "BILLING"
                    | "HQ_LOCATION"
                    | "PLACE_OF_BUSINESS"
                    | "SUBSIDIARY";
                    cityCounty: string;
                    countryCode: string;
                    moveInDate?: string
                    | null;
                    stateRegion?: string | null;
                    street1: string;
                    street2?: string | null;
                    zip: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            addressId?: string | null;
                            addressTypeCode?: string | null;
                            apartmentNumber?: string | null;
                            buildingName?: string | null;
                            buildingNumber?: string | null;
                            cityCounty?: string | null;
                            countryCode?: string | null;
                            department?: string | null;
                            district?: string | null;
                            floor?: string | null;
                            moveInDate?: string | null;
                            personId?: string | null;
                            postBox?: string | null;
                            stateRegion?: string | null;
                            street1?: string | null;
                            street2?: string | null;
                            streetName?: string | null;
                            structured?: boolean | null;
                            subDepartment?: string | null;
                            townLocationName?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                            zip?: string
                            | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          addressId?: string | null;
                          addressTypeCode?: string | null;
                          apartmentNumber?: string | null;
                          buildingName?: string | null;
                          buildingNumber?: string | null;
                          cityCounty?: string | null;
                          countryCode?: string | null;
                          department?: string | null;
                          district?: string | null;
                          floor?: string | null;
                          moveInDate?: string | null;
                          personId?: string | null;
                          postBox?: string | null;
                          stateRegion?: string | null;
                          street1?: string | null;
                          street2?: string | null;
                          streetName?: string | null;
                          structured?: boolean | null;
                          subDepartment?: string | null;
                          townLocationName?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                          zip?: string
                          | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v2/persons/{personId}/addresses/{addressId}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { addressId: string; personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    };
                    "application/json": {
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    };
                    "text/json": {
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                addressId?: string
                                | null;
                                addressTypeCode?: string | null;
                                apartmentNumber?: string | null;
                                buildingName?: string | null;
                                buildingNumber?: string | null;
                                cityCounty?: string | null;
                                countryCode?: string | null;
                                department?: string | null;
                                district?: string | null;
                                floor?: string | null;
                                moveInDate?: string | null;
                                personId?: string | null;
                                postBox?: string | null;
                                stateRegion?: string | null;
                                street1?: string | null;
                                street2?: string | null;
                                streetName?: string | null;
                                structured?: boolean | null;
                                subDepartment?: string | null;
                                townLocationName?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                                zip?: string
                                | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { addressId: string; personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      cityCounty: string;
                      countryCode: string;
                      moveInDate?: string
                      | null;
                      stateRegion?: string | null;
                      street1: string;
                      street2?: string | null;
                      zip: string;
                  };
                  "application/json": {
                      cityCounty: string;
                      countryCode: string;
                      moveInDate?: string
                      | null;
                      stateRegion?: string | null;
                      street1: string;
                      street2?: string | null;
                      zip: string;
                  };
                  "text/json": {
                      cityCounty: string;
                      countryCode: string;
                      moveInDate?: string
                      | null;
                      stateRegion?: string | null;
                      street1: string;
                      street2?: string | null;
                      zip: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              addressId?: string
                              | null;
                              addressTypeCode?: string | null;
                              apartmentNumber?: string | null;
                              buildingName?: string | null;
                              buildingNumber?: string | null;
                              cityCounty?: string | null;
                              countryCode?: string | null;
                              department?: string | null;
                              district?: string | null;
                              floor?: string | null;
                              moveInDate?: string | null;
                              personId?: string | null;
                              postBox?: string | null;
                              stateRegion?: string | null;
                              street1?: string | null;
                              street2?: string | null;
                              streetName?: string | null;
                              structured?: boolean | null;
                              subDepartment?: string | null;
                              townLocationName?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                              zip?: string
                              | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update person address

      Changes address of a person

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { addressId: string; personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { addressId: string; personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    cityCounty: string;
                    countryCode: string;
                    moveInDate?: string | null;
                    stateRegion?: string | null;
                    street1: string;
                    street2?: string | null;
                    zip: string;
                };
                "application/json": {
                    cityCounty: string;
                    countryCode: string;
                    moveInDate?: string
                    | null;
                    stateRegion?: string | null;
                    street1: string;
                    street2?: string | null;
                    zip: string;
                };
                "text/json": {
                    cityCounty: string;
                    countryCode: string;
                    moveInDate?: string
                    | null;
                    stateRegion?: string | null;
                    street1: string;
                    street2?: string | null;
                    zip: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            addressId?: string | null;
                            addressTypeCode?: string | null;
                            apartmentNumber?: string | null;
                            buildingName?: string | null;
                            buildingNumber?: string | null;
                            cityCounty?: string | null;
                            countryCode?: string | null;
                            department?: string | null;
                            district?: string | null;
                            floor?: string | null;
                            moveInDate?: string | null;
                            personId?: string | null;
                            postBox?: string | null;
                            stateRegion?: string | null;
                            street1?: string | null;
                            street2?: string | null;
                            streetName?: string | null;
                            structured?: boolean | null;
                            subDepartment?: string | null;
                            townLocationName?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                            zip?: string
                            | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          addressId?: string | null;
                          addressTypeCode?: string | null;
                          apartmentNumber?: string | null;
                          buildingName?: string | null;
                          buildingNumber?: string | null;
                          cityCounty?: string | null;
                          countryCode?: string | null;
                          department?: string | null;
                          district?: string | null;
                          floor?: string | null;
                          moveInDate?: string | null;
                          personId?: string | null;
                          postBox?: string | null;
                          stateRegion?: string | null;
                          street1?: string | null;
                          street2?: string | null;
                          streetName?: string | null;
                          structured?: boolean | null;
                          subDepartment?: string | null;
                          townLocationName?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                          zip?: string
                          | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/v2/persons/{personId}/relations": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: { includeAccessRestricted?: boolean };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean | null;
                                parent?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                parentPersonId?: string
                                | null;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                person?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                personId?: string
                                | null;
                                personRelationshipId?: string | null;
                                relationTypeCode?: string | null;
                                representingRange?: { endDate?: ...; startDate?: ... };
                                role?: string | null;
                                statusCode?: string | null;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: { includeAccessRestricted?: boolean };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean | null;
                              parent?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              parentPersonId?: string
                              | null;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              person?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              personId?: string
                              | null;
                              personRelationshipId?: string | null;
                              relationTypeCode?: string | null;
                              representingRange?: { endDate?: ...; startDate?: ... };
                              role?: string | null;
                              statusCode?: string | null;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Retrieve person relationship

      Retrieve the Private person relationships to a Legal Person

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: { includeAccessRestricted?: boolean };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
          • personId: string
            ID-1030
            
        • Optionalquery?: { includeAccessRestricted?: boolean }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?:
                            | {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean | null;
                                parent?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                parentPersonId?: string
                                | null;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                person?: {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                };
                                personId?: string
                                | null;
                                personRelationshipId?: string | null;
                                relationTypeCode?: string | null;
                                representingRange?: { endDate?: ...; startDate?: ... };
                                role?: string | null;
                                statusCode?: string | null;
                                validityRange?: { endTime?: ...; startTime?: ... };
                            }[]
                            | null;
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?:
                          | {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean | null;
                              parent?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              parentPersonId?: string
                              | null;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              person?: {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              };
                              personId?: string
                              | null;
                              personRelationshipId?: string | null;
                              relationTypeCode?: string | null;
                              representingRange?: { endDate?: ...; startDate?: ... };
                              role?: string | null;
                              statusCode?: string | null;
                              validityRange?: { endTime?: ...; startTime?: ... };
                          }[]
                          | null;
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v2/persons/{personId}/relations/{personRelationshipId}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string; personRelationshipId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        additionalData?: string
                        | null;
                        beneficiary?: boolean;
                        percentageOfShares?: number | null;
                        percentageOfSignature?: number | null;
                        representingRange: {
                            endDate?: string | null;
                            startDate?: string | null;
                        };
                        role?: string
                        | null;
                        statusCode: "ACTIVE" | "INACTIVE";
                    };
                    "application/json": {
                        additionalData?: string
                        | null;
                        beneficiary?: boolean;
                        percentageOfShares?: number | null;
                        percentageOfSignature?: number | null;
                        representingRange: {
                            endDate?: string | null;
                            startDate?: string | null;
                        };
                        role?: string
                        | null;
                        statusCode: "ACTIVE" | "INACTIVE";
                    };
                    "text/json": {
                        additionalData?: string
                        | null;
                        beneficiary?: boolean;
                        percentageOfShares?: number | null;
                        percentageOfSignature?: number | null;
                        representingRange: {
                            endDate?: string | null;
                            startDate?: string | null;
                        };
                        role?: string
                        | null;
                        statusCode: "ACTIVE" | "INACTIVE";
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                additionalData?: string
                                | null;
                                beneficiary?: boolean | null;
                                parent?: {
                                    accessRestricted?: (...) | (...) | (...) | (...);
                                    activityCode?: (...) | (...) | (...);
                                    birthDate?: (...) | (...) | (...);
                                    buildingTypeCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    creationDate?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                    forgotten?: (...) | (...) | (...) | (...);
                                    fullName?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                    idCountryCode?: (...) | (...) | (...);
                                    idNumber?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    insertedDTime?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    personGroupCodes?: (...) | (...) | (...);
                                    personId?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    source?: (...) | (...);
                                    statusCode?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tenantCode?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                parentPersonId?: string
                                | null;
                                percentageOfShares?: number | null;
                                percentageOfSignature?: number | null;
                                person?: {
                                    accessRestricted?: (...) | (...) | (...) | (...);
                                    activityCode?: (...) | (...) | (...);
                                    birthDate?: (...) | (...) | (...);
                                    buildingTypeCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    creationDate?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                    forgotten?: (...) | (...) | (...) | (...);
                                    fullName?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                    idCountryCode?: (...) | (...) | (...);
                                    idNumber?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    insertedDTime?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    personGroupCodes?: (...) | (...) | (...);
                                    personId?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    source?: (...) | (...);
                                    statusCode?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tenantCode?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                personId?: string
                                | null;
                                personRelationshipId?: string | null;
                                relationTypeCode?: string | null;
                                representingRange?: {
                                    endDate?: (...) | (...) | (...);
                                    startDate?: (...) | (...) | (...);
                                };
                                role?: string
                                | null;
                                statusCode?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string; personRelationshipId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      additionalData?: string
                      | null;
                      beneficiary?: boolean;
                      percentageOfShares?: number | null;
                      percentageOfSignature?: number | null;
                      representingRange: {
                          endDate?: string | null;
                          startDate?: string | null;
                      };
                      role?: string
                      | null;
                      statusCode: "ACTIVE" | "INACTIVE";
                  };
                  "application/json": {
                      additionalData?: string
                      | null;
                      beneficiary?: boolean;
                      percentageOfShares?: number | null;
                      percentageOfSignature?: number | null;
                      representingRange: {
                          endDate?: string | null;
                          startDate?: string | null;
                      };
                      role?: string
                      | null;
                      statusCode: "ACTIVE" | "INACTIVE";
                  };
                  "text/json": {
                      additionalData?: string
                      | null;
                      beneficiary?: boolean;
                      percentageOfShares?: number | null;
                      percentageOfSignature?: number | null;
                      representingRange: {
                          endDate?: string | null;
                          startDate?: string | null;
                      };
                      role?: string
                      | null;
                      statusCode: "ACTIVE" | "INACTIVE";
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              additionalData?: string
                              | null;
                              beneficiary?: boolean | null;
                              parent?: {
                                  accessRestricted?: (...) | (...) | (...) | (...);
                                  activityCode?: (...) | (...) | (...);
                                  birthDate?: (...) | (...) | (...);
                                  buildingTypeCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  creationDate?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                                  forgotten?: (...) | (...) | (...) | (...);
                                  fullName?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                                  idCountryCode?: (...) | (...) | (...);
                                  idNumber?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  insertedDTime?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  personGroupCodes?: (...) | (...) | (...);
                                  personId?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  source?: (...) | (...);
                                  statusCode?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tenantCode?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              parentPersonId?: string
                              | null;
                              percentageOfShares?: number | null;
                              percentageOfSignature?: number | null;
                              person?: {
                                  accessRestricted?: (...) | (...) | (...) | (...);
                                  activityCode?: (...) | (...) | (...);
                                  birthDate?: (...) | (...) | (...);
                                  buildingTypeCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  creationDate?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                                  forgotten?: (...) | (...) | (...) | (...);
                                  fullName?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                                  idCountryCode?: (...) | (...) | (...);
                                  idNumber?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  insertedDTime?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  personGroupCodes?: (...) | (...) | (...);
                                  personId?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  source?: (...) | (...);
                                  statusCode?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tenantCode?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              personId?: string
                              | null;
                              personRelationshipId?: string | null;
                              relationTypeCode?: string | null;
                              representingRange?: {
                                  endDate?: (...) | (...) | (...);
                                  startDate?: (...) | (...) | (...);
                              };
                              role?: string
                              | null;
                              statusCode?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update person relationship

      Update the Private person relationships to a Legal person

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string; personRelationshipId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string; personRelationshipId: string }
          • personId: string
            ID-1030
            
          • personRelationshipId: string
            ID-1031
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    additionalData?: string | null;
                    beneficiary?: boolean;
                    percentageOfShares?: number | null;
                    percentageOfSignature?: number | null;
                    representingRange: { endDate?: string | null; startDate?: string | null };
                    role?: string | null;
                    statusCode: "ACTIVE" | "INACTIVE";
                };
                "application/json": {
                    additionalData?: string
                    | null;
                    beneficiary?: boolean;
                    percentageOfShares?: number | null;
                    percentageOfSignature?: number | null;
                    representingRange: { endDate?: string | null; startDate?: string | null };
                    role?: string | null;
                    statusCode: "ACTIVE" | "INACTIVE";
                };
                "text/json": {
                    additionalData?: string
                    | null;
                    beneficiary?: boolean;
                    percentageOfShares?: number | null;
                    percentageOfSignature?: number | null;
                    representingRange: { endDate?: string | null; startDate?: string | null };
                    role?: string | null;
                    statusCode: "ACTIVE" | "INACTIVE";
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            additionalData?: string | null;
                            beneficiary?: boolean | null;
                            parent?: {
                                accessRestricted?: (...) | (...) | (...) | (...);
                                activityCode?: (...) | (...) | (...);
                                birthDate?: (...) | (...) | (...);
                                buildingTypeCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                creationDate?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                                forgotten?: (...) | (...) | (...) | (...);
                                fullName?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                                idCountryCode?: (...) | (...) | (...);
                                idNumber?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                insertedDTime?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                personGroupCodes?: (...) | (...) | (...);
                                personId?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                source?: (...) | (...);
                                statusCode?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tenantCode?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            parentPersonId?: string
                            | null;
                            percentageOfShares?: number | null;
                            percentageOfSignature?: number | null;
                            person?: {
                                accessRestricted?: (...) | (...) | (...) | (...);
                                activityCode?: (...) | (...) | (...);
                                birthDate?: (...) | (...) | (...);
                                buildingTypeCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                creationDate?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                                forgotten?: (...) | (...) | (...) | (...);
                                fullName?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                                idCountryCode?: (...) | (...) | (...);
                                idNumber?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                insertedDTime?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                personGroupCodes?: (...) | (...) | (...);
                                personId?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                source?: (...) | (...);
                                statusCode?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tenantCode?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            personId?: string
                            | null;
                            personRelationshipId?: string | null;
                            relationTypeCode?: string | null;
                            representingRange?: {
                                endDate?: (...) | (...) | (...);
                                startDate?: (...) | (...) | (...);
                            };
                            role?: string
                            | null;
                            statusCode?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          additionalData?: string | null;
                          beneficiary?: boolean | null;
                          parent?: {
                              accessRestricted?: (...) | (...) | (...) | (...);
                              activityCode?: (...) | (...) | (...);
                              birthDate?: (...) | (...) | (...);
                              buildingTypeCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              creationDate?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                              forgotten?: (...) | (...) | (...) | (...);
                              fullName?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                              idCountryCode?: (...) | (...) | (...);
                              idNumber?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              insertedDTime?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              personGroupCodes?: (...) | (...) | (...);
                              personId?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              source?: (...) | (...);
                              statusCode?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tenantCode?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          parentPersonId?: string
                          | null;
                          percentageOfShares?: number | null;
                          percentageOfSignature?: number | null;
                          person?: {
                              accessRestricted?: (...) | (...) | (...) | (...);
                              activityCode?: (...) | (...) | (...);
                              birthDate?: (...) | (...) | (...);
                              buildingTypeCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              creationDate?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                              forgotten?: (...) | (...) | (...) | (...);
                              fullName?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                              idCountryCode?: (...) | (...) | (...);
                              idNumber?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              insertedDTime?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              personGroupCodes?: (...) | (...) | (...);
                              personId?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              source?: (...) | (...);
                              statusCode?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tenantCode?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          personId?: string
                          | null;
                          personRelationshipId?: string | null;
                          relationTypeCode?: string | null;
                          representingRange?: {
                              endDate?: (...) | (...) | (...);
                              startDate?: (...) | (...) | (...);
                          };
                          role?: string
                          | null;
                          statusCode?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/v2/persons/custom-fields/value": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        entityName: string;
                        entityRef: string;
                        fieldId: string;
                        fieldValue: unknown;
                    };
                    "application/json": {
                        entityName: string;
                        entityRef: string;
                        fieldId: string;
                        fieldValue: unknown;
                    };
                    "text/json": {
                        entityName: string;
                        entityRef: string;
                        fieldId: string;
                        fieldValue: unknown;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        entityName: string;
                        entityRef: string;
                        fieldId: string;
                        fieldValue: unknown;
                    };
                    "application/json": {
                        entityName: string;
                        entityRef: string;
                        fieldId: string;
                        fieldValue: unknown;
                    };
                    "text/json": {
                        entityName: string;
                        entityRef: string;
                        fieldId: string;
                        fieldValue: unknown;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      entityName: string;
                      entityRef: string;
                      fieldId: string;
                      fieldValue: unknown;
                  };
                  "application/json": {
                      entityName: string;
                      entityRef: string;
                      fieldId: string;
                      fieldValue: unknown;
                  };
                  "text/json": {
                      entityName: string;
                      entityRef: string;
                      fieldId: string;
                      fieldValue: unknown;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Insert custom field for a person

      Add additional information for a person such as:

      • Occupation (SOC) code for a Private Person (see full list)
      • IP address, valid for both Private and Legal Persons

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    entityName: string;
                    entityRef: string;
                    fieldId: string;
                    fieldValue: unknown;
                };
                "application/json": {
                    entityName: string;
                    entityRef: string;
                    fieldId: string;
                    fieldValue: unknown;
                };
                "text/json": {
                    entityName: string;
                    entityRef: string;
                    fieldId: string;
                    fieldValue: unknown;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      entityName: string;
                      entityRef: string;
                      fieldId: string;
                      fieldValue: unknown;
                  };
                  "application/json": {
                      entityName: string;
                      entityRef: string;
                      fieldId: string;
                      fieldValue: unknown;
                  };
                  "text/json": {
                      entityName: string;
                      entityRef: string;
                      fieldId: string;
                      fieldValue: unknown;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update custom field for a person

      Add additional information for a person such as:

      • Occupation (SOC) code for a Private Person (see full list)
      • IP address, valid for both Private and Legal Persons

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    entityName: string;
                    entityRef: string;
                    fieldId: string;
                    fieldValue: unknown;
                };
                "application/json": {
                    entityName: string;
                    entityRef: string;
                    fieldId: string;
                    fieldValue: unknown;
                };
                "text/json": {
                    entityName: string;
                    entityRef: string;
                    fieldId: string;
                    fieldValue: unknown;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/v2/persons/search": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        addressTypeCode?: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        birthDate?: string
                        | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        country?: string | null;
                        creationDateFrom?: string | null;
                        creationDateTo?: string | null;
                        email?: string | null;
                        firstName?: string | null;
                        globalSearch?: string | null;
                        idNumber?: string | null;
                        includeAccessRestricted?: boolean | null;
                        intraOrgCode?: string | null;
                        lastName?: string | null;
                        legalForm?: string | null;
                        name?: string | null;
                        pageNumber?: number;
                        pageSize?: number;
                        pepExplanation?: string | null;
                        personGroupCodes?: string[] | null;
                        personId?: string | null;
                        personIds?: string[] | null;
                        personTypeCode?: "P" | "L";
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        registrationDate?: string | null;
                        residencyCountryCode?: string | null;
                        sort?: { field?: string | null; order?: string | null }[] | null;
                        statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                        statusCodeReason?: string | null;
                        statusCodes?: string[] | null;
                        tradingName?: string | null;
                        webAddress?: string | null;
                        zip?: string | null;
                    };
                    "application/json": {
                        addressTypeCode?: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        birthDate?: string
                        | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        country?: string | null;
                        creationDateFrom?: string | null;
                        creationDateTo?: string | null;
                        email?: string | null;
                        firstName?: string | null;
                        globalSearch?: string | null;
                        idNumber?: string | null;
                        includeAccessRestricted?: boolean | null;
                        intraOrgCode?: string | null;
                        lastName?: string | null;
                        legalForm?: string | null;
                        name?: string | null;
                        pageNumber?: number;
                        pageSize?: number;
                        pepExplanation?: string | null;
                        personGroupCodes?: string[] | null;
                        personId?: string | null;
                        personIds?: string[] | null;
                        personTypeCode?: "P" | "L";
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        registrationDate?: string | null;
                        residencyCountryCode?: string | null;
                        sort?: { field?: string | null; order?: string | null }[] | null;
                        statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                        statusCodeReason?: string | null;
                        statusCodes?: string[] | null;
                        tradingName?: string | null;
                        webAddress?: string | null;
                        zip?: string | null;
                    };
                    "text/json": {
                        addressTypeCode?: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        birthDate?: string
                        | null;
                        businessModelDescription?: string | null;
                        counterpartySectorCode?: string | null;
                        country?: string | null;
                        creationDateFrom?: string | null;
                        creationDateTo?: string | null;
                        email?: string | null;
                        firstName?: string | null;
                        globalSearch?: string | null;
                        idNumber?: string | null;
                        includeAccessRestricted?: boolean | null;
                        intraOrgCode?: string | null;
                        lastName?: string | null;
                        legalForm?: string | null;
                        name?: string | null;
                        pageNumber?: number;
                        pageSize?: number;
                        pepExplanation?: string | null;
                        personGroupCodes?: string[] | null;
                        personId?: string | null;
                        personIds?: string[] | null;
                        personTypeCode?: "P" | "L";
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        registrationDate?: string | null;
                        residencyCountryCode?: string | null;
                        sort?: { field?: string | null; order?: string | null }[] | null;
                        statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                        statusCodeReason?: string | null;
                        statusCodes?: string[] | null;
                        tradingName?: string | null;
                        webAddress?: string | null;
                        zip?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                values?:
                                    | {
                                        accessRestricted?: ...;
                                        activityCode?: ...;
                                        birthDate?: ...;
                                        buildingTypeCode?: ...;
                                        businessAreaCodes?: ...;
                                        businessModelDescription?: ...;
                                        counterpartySectorCode?: ...;
                                        countryOfBirth?: ...;
                                        creationDate?: ...;
                                        customerTypeCode?: ...;
                                        deathDate?: ...;
                                        dependantPersons?: ...;
                                        educationCode?: ...;
                                        email?: ...;
                                        employmentTimeCode?: ...;
                                        fixedEmploymentLength?: ...;
                                        forgotten?: ...;
                                        fullName?: ...;
                                        givenName?: ...;
                                        housingTypeCode?: ...;
                                        idCountryCode?: ...;
                                        idNumber?: ...;
                                        inactivationDate?: ...;
                                        insertedDTime?: ...;
                                        intraOrgCode?: ...;
                                        language?: ...;
                                        legalForm?: ...;
                                        liquidationDate?: ...;
                                        mainPersonId?: ...;
                                        maritalStatusCode?: ...;
                                        middleName?: ...;
                                        name?: ...;
                                        nationality?: ...;
                                        pep?: ...;
                                        pepExplanation?: ...;
                                        personGroupCodes?: ...;
                                        personId?: ...;
                                        personTypeCode?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        placeOfBirth?: ...;
                                        registrationDate?: ...;
                                        residencyCountryCode?: ...;
                                        sex?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusCodeReason?: ...;
                                        surname?: ...;
                                        taxResidencyCountry?: ...;
                                        tenantCode?: ...;
                                        tradingName?: ...;
                                        usResident?: ...;
                                        webAddress?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      addressTypeCode?: | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                      birthDate?: string
                      | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      country?: string | null;
                      creationDateFrom?: string | null;
                      creationDateTo?: string | null;
                      email?: string | null;
                      firstName?: string | null;
                      globalSearch?: string | null;
                      idNumber?: string | null;
                      includeAccessRestricted?: boolean | null;
                      intraOrgCode?: string | null;
                      lastName?: string | null;
                      legalForm?: string | null;
                      name?: string | null;
                      pageNumber?: number;
                      pageSize?: number;
                      pepExplanation?: string | null;
                      personGroupCodes?: string[] | null;
                      personId?: string | null;
                      personIds?: string[] | null;
                      personTypeCode?: "P" | "L";
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      registrationDate?: string | null;
                      residencyCountryCode?: string | null;
                      sort?: { field?: string | null; order?: string | null }[] | null;
                      statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                      statusCodeReason?: string | null;
                      statusCodes?: string[] | null;
                      tradingName?: string | null;
                      webAddress?: string | null;
                      zip?: string | null;
                  };
                  "application/json": {
                      addressTypeCode?: | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                      birthDate?: string
                      | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      country?: string | null;
                      creationDateFrom?: string | null;
                      creationDateTo?: string | null;
                      email?: string | null;
                      firstName?: string | null;
                      globalSearch?: string | null;
                      idNumber?: string | null;
                      includeAccessRestricted?: boolean | null;
                      intraOrgCode?: string | null;
                      lastName?: string | null;
                      legalForm?: string | null;
                      name?: string | null;
                      pageNumber?: number;
                      pageSize?: number;
                      pepExplanation?: string | null;
                      personGroupCodes?: string[] | null;
                      personId?: string | null;
                      personIds?: string[] | null;
                      personTypeCode?: "P" | "L";
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      registrationDate?: string | null;
                      residencyCountryCode?: string | null;
                      sort?: { field?: string | null; order?: string | null }[] | null;
                      statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                      statusCodeReason?: string | null;
                      statusCodes?: string[] | null;
                      tradingName?: string | null;
                      webAddress?: string | null;
                      zip?: string | null;
                  };
                  "text/json": {
                      addressTypeCode?: | "R"
                      | "C"
                      | "B"
                      | "D"
                      | "BILLING"
                      | "HQ_LOCATION"
                      | "PLACE_OF_BUSINESS"
                      | "SUBSIDIARY";
                      birthDate?: string
                      | null;
                      businessModelDescription?: string | null;
                      counterpartySectorCode?: string | null;
                      country?: string | null;
                      creationDateFrom?: string | null;
                      creationDateTo?: string | null;
                      email?: string | null;
                      firstName?: string | null;
                      globalSearch?: string | null;
                      idNumber?: string | null;
                      includeAccessRestricted?: boolean | null;
                      intraOrgCode?: string | null;
                      lastName?: string | null;
                      legalForm?: string | null;
                      name?: string | null;
                      pageNumber?: number;
                      pageSize?: number;
                      pepExplanation?: string | null;
                      personGroupCodes?: string[] | null;
                      personId?: string | null;
                      personIds?: string[] | null;
                      personTypeCode?: "P" | "L";
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      registrationDate?: string | null;
                      residencyCountryCode?: string | null;
                      sort?: { field?: string | null; order?: string | null }[] | null;
                      statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                      statusCodeReason?: string | null;
                      statusCodes?: string[] | null;
                      tradingName?: string | null;
                      webAddress?: string | null;
                      zip?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              values?:
                                  | {
                                      accessRestricted?: ...;
                                      activityCode?: ...;
                                      birthDate?: ...;
                                      buildingTypeCode?: ...;
                                      businessAreaCodes?: ...;
                                      businessModelDescription?: ...;
                                      counterpartySectorCode?: ...;
                                      countryOfBirth?: ...;
                                      creationDate?: ...;
                                      customerTypeCode?: ...;
                                      deathDate?: ...;
                                      dependantPersons?: ...;
                                      educationCode?: ...;
                                      email?: ...;
                                      employmentTimeCode?: ...;
                                      fixedEmploymentLength?: ...;
                                      forgotten?: ...;
                                      fullName?: ...;
                                      givenName?: ...;
                                      housingTypeCode?: ...;
                                      idCountryCode?: ...;
                                      idNumber?: ...;
                                      inactivationDate?: ...;
                                      insertedDTime?: ...;
                                      intraOrgCode?: ...;
                                      language?: ...;
                                      legalForm?: ...;
                                      liquidationDate?: ...;
                                      mainPersonId?: ...;
                                      maritalStatusCode?: ...;
                                      middleName?: ...;
                                      name?: ...;
                                      nationality?: ...;
                                      pep?: ...;
                                      pepExplanation?: ...;
                                      personGroupCodes?: ...;
                                      personId?: ...;
                                      personTypeCode?: ...;
                                      phoneCountryCode?: ...;
                                      phoneNumber?: ...;
                                      placeOfBirth?: ...;
                                      registrationDate?: ...;
                                      residencyCountryCode?: ...;
                                      sex?: ...;
                                      source?: ...;
                                      statusCode?: ...;
                                      statusCodeReason?: ...;
                                      surname?: ...;
                                      taxResidencyCountry?: ...;
                                      tenantCode?: ...;
                                      tradingName?: ...;
                                      usResident?: ...;
                                      webAddress?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Search Persons

      Returns pageable list of persons. This endpoint accepts search criteria in the request body to avoid exposing sensitive data in URL parameters.

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string

            A client-generated UUID used to deduplicate POST requests so that repeated calls with the same values are processed only once.

          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    addressTypeCode?:
                        | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                    birthDate?: string
                    | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    country?: string | null;
                    creationDateFrom?: string | null;
                    creationDateTo?: string | null;
                    email?: string | null;
                    firstName?: string | null;
                    globalSearch?: string | null;
                    idNumber?: string | null;
                    includeAccessRestricted?: boolean | null;
                    intraOrgCode?: string | null;
                    lastName?: string | null;
                    legalForm?: string | null;
                    name?: string | null;
                    pageNumber?: number;
                    pageSize?: number;
                    pepExplanation?: string | null;
                    personGroupCodes?: string[] | null;
                    personId?: string | null;
                    personIds?: string[] | null;
                    personTypeCode?: "P" | "L";
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    registrationDate?: string | null;
                    residencyCountryCode?: string | null;
                    sort?: { field?: string | null; order?: string | null }[] | null;
                    statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                    statusCodeReason?: string | null;
                    statusCodes?: string[] | null;
                    tradingName?: string | null;
                    webAddress?: string | null;
                    zip?: string | null;
                };
                "application/json": {
                    addressTypeCode?: | "R"
                    | "C"
                    | "B"
                    | "D"
                    | "BILLING"
                    | "HQ_LOCATION"
                    | "PLACE_OF_BUSINESS"
                    | "SUBSIDIARY";
                    birthDate?: string
                    | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    country?: string | null;
                    creationDateFrom?: string | null;
                    creationDateTo?: string | null;
                    email?: string | null;
                    firstName?: string | null;
                    globalSearch?: string | null;
                    idNumber?: string | null;
                    includeAccessRestricted?: boolean | null;
                    intraOrgCode?: string | null;
                    lastName?: string | null;
                    legalForm?: string | null;
                    name?: string | null;
                    pageNumber?: number;
                    pageSize?: number;
                    pepExplanation?: string | null;
                    personGroupCodes?: string[] | null;
                    personId?: string | null;
                    personIds?: string[] | null;
                    personTypeCode?: "P" | "L";
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    registrationDate?: string | null;
                    residencyCountryCode?: string | null;
                    sort?: { field?: string | null; order?: string | null }[] | null;
                    statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                    statusCodeReason?: string | null;
                    statusCodes?: string[] | null;
                    tradingName?: string | null;
                    webAddress?: string | null;
                    zip?: string | null;
                };
                "text/json": {
                    addressTypeCode?: | "R"
                    | "C"
                    | "B"
                    | "D"
                    | "BILLING"
                    | "HQ_LOCATION"
                    | "PLACE_OF_BUSINESS"
                    | "SUBSIDIARY";
                    birthDate?: string
                    | null;
                    businessModelDescription?: string | null;
                    counterpartySectorCode?: string | null;
                    country?: string | null;
                    creationDateFrom?: string | null;
                    creationDateTo?: string | null;
                    email?: string | null;
                    firstName?: string | null;
                    globalSearch?: string | null;
                    idNumber?: string | null;
                    includeAccessRestricted?: boolean | null;
                    intraOrgCode?: string | null;
                    lastName?: string | null;
                    legalForm?: string | null;
                    name?: string | null;
                    pageNumber?: number;
                    pageSize?: number;
                    pepExplanation?: string | null;
                    personGroupCodes?: string[] | null;
                    personId?: string | null;
                    personIds?: string[] | null;
                    personTypeCode?: "P" | "L";
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    registrationDate?: string | null;
                    residencyCountryCode?: string | null;
                    sort?: { field?: string | null; order?: string | null }[] | null;
                    statusCode?: "ACTIVE" | "INACTIVE" | "PENDING";
                    statusCodeReason?: string | null;
                    statusCodes?: string[] | null;
                    tradingName?: string | null;
                    webAddress?: string | null;
                    zip?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            values?:
                                | {
                                    accessRestricted?: ...;
                                    activityCode?: ...;
                                    birthDate?: ...;
                                    buildingTypeCode?: ...;
                                    businessAreaCodes?: ...;
                                    businessModelDescription?: ...;
                                    counterpartySectorCode?: ...;
                                    countryOfBirth?: ...;
                                    creationDate?: ...;
                                    customerTypeCode?: ...;
                                    deathDate?: ...;
                                    dependantPersons?: ...;
                                    educationCode?: ...;
                                    email?: ...;
                                    employmentTimeCode?: ...;
                                    fixedEmploymentLength?: ...;
                                    forgotten?: ...;
                                    fullName?: ...;
                                    givenName?: ...;
                                    housingTypeCode?: ...;
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    inactivationDate?: ...;
                                    insertedDTime?: ...;
                                    intraOrgCode?: ...;
                                    language?: ...;
                                    legalForm?: ...;
                                    liquidationDate?: ...;
                                    mainPersonId?: ...;
                                    maritalStatusCode?: ...;
                                    middleName?: ...;
                                    name?: ...;
                                    nationality?: ...;
                                    pep?: ...;
                                    pepExplanation?: ...;
                                    personGroupCodes?: ...;
                                    personId?: ...;
                                    personTypeCode?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    placeOfBirth?: ...;
                                    registrationDate?: ...;
                                    residencyCountryCode?: ...;
                                    sex?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusCodeReason?: ...;
                                    surname?: ...;
                                    taxResidencyCountry?: ...;
                                    tenantCode?: ...;
                                    tradingName?: ...;
                                    usResident?: ...;
                                    webAddress?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          values?:
                              | {
                                  accessRestricted?: ...;
                                  activityCode?: ...;
                                  birthDate?: ...;
                                  buildingTypeCode?: ...;
                                  businessAreaCodes?: ...;
                                  businessModelDescription?: ...;
                                  counterpartySectorCode?: ...;
                                  countryOfBirth?: ...;
                                  creationDate?: ...;
                                  customerTypeCode?: ...;
                                  deathDate?: ...;
                                  dependantPersons?: ...;
                                  educationCode?: ...;
                                  email?: ...;
                                  employmentTimeCode?: ...;
                                  fixedEmploymentLength?: ...;
                                  forgotten?: ...;
                                  fullName?: ...;
                                  givenName?: ...;
                                  housingTypeCode?: ...;
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  inactivationDate?: ...;
                                  insertedDTime?: ...;
                                  intraOrgCode?: ...;
                                  language?: ...;
                                  legalForm?: ...;
                                  liquidationDate?: ...;
                                  mainPersonId?: ...;
                                  maritalStatusCode?: ...;
                                  middleName?: ...;
                                  name?: ...;
                                  nationality?: ...;
                                  pep?: ...;
                                  pepExplanation?: ...;
                                  personGroupCodes?: ...;
                                  personId?: ...;
                                  personTypeCode?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  placeOfBirth?: ...;
                                  registrationDate?: ...;
                                  residencyCountryCode?: ...;
                                  sex?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusCodeReason?: ...;
                                  surname?: ...;
                                  taxResidencyCountry?: ...;
                                  tenantCode?: ...;
                                  tradingName?: ...;
                                  usResident?: ...;
                                  webAddress?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/accounts/{accountId}/payments": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { accountId: string };
                query: {
                    amountFrom?: number;
                    amountTo?: number;
                    cancellationRequestStatusCodes?: string[];
                    contractNumber?: string;
                    counterpartyAccountNumber?: string;
                    currencyCodes?: string[];
                    details?: string;
                    directionCode?: string;
                    isNotSettled?: boolean;
                    isSettled?: boolean;
                    pageNumber: number;
                    pageSize: number;
                    paymentId?: string;
                    paymentServiceProviderCode?: string;
                    paymentTypeCodes?: string[];
                    postingDateFrom?: string;
                    postingDateTo?: string;
                    referenceNumber?: string;
                    sourceName?: string;
                    sourceRef?: string;
                    statusCodes?: string[];
                    valueDateFrom?: string;
                    valueDateTo?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                values?:
                                    | {
                                        accountId?: ...;
                                        amlDeclineReason?: ...;
                                        amlMonitoringEnabled?: ...;
                                        autoConfirm?: ...;
                                        cancellationRequestStatusCode?: ...;
                                        cancelReason?: ...;
                                        cancelRefuseReason?: ...;
                                        categoryPurposeCode?: ...;
                                        chargeBearer?: ...;
                                        contractSource?: ...;
                                        counterpartyOriginalIban?: ...;
                                        details?: ...;
                                        directionCode?: ...;
                                        endToEndId?: ...;
                                        errorCode?: ...;
                                        fees?: ...;
                                        fileImportLineNumber?: ...;
                                        fxPayment?: ...;
                                        fxPaymentFlag?: ...;
                                        insertedDateTime?: ...;
                                        labels?: ...;
                                        lastStatusRequestDate?: ...;
                                        money?: ...;
                                        paymentCancellationReasonCode?: ...;
                                        paymentId?: ...;
                                        paymentParties?: ...;
                                        paymentSchemeElements?: ...;
                                        paymentServiceProviderCode?: ...;
                                        paymentTypeCode?: ...;
                                        postingDate?: ...;
                                        preferredPaymentScheme?: ...;
                                        purposeCode?: ...;
                                        referenceNumber?: ...;
                                        residencyCountryCode?: ...;
                                        returnComment?: ...;
                                        returnReason?: ...;
                                        returnSettlementDate?: ...;
                                        returnStatusCode?: ...;
                                        selectedPaymentScheme?: ...;
                                        settlementDate?: ...;
                                        settlementErrorCode?: ...;
                                        settlementPaymentScheme?: ...;
                                        settlementStatusCode?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        tenantCode?: ...;
                                        uetr?: ...;
                                        valueDate?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { accountId: string };
              query: {
                  amountFrom?: number;
                  amountTo?: number;
                  cancellationRequestStatusCodes?: string[];
                  contractNumber?: string;
                  counterpartyAccountNumber?: string;
                  currencyCodes?: string[];
                  details?: string;
                  directionCode?: string;
                  isNotSettled?: boolean;
                  isSettled?: boolean;
                  pageNumber: number;
                  pageSize: number;
                  paymentId?: string;
                  paymentServiceProviderCode?: string;
                  paymentTypeCodes?: string[];
                  postingDateFrom?: string;
                  postingDateTo?: string;
                  referenceNumber?: string;
                  sourceName?: string;
                  sourceRef?: string;
                  statusCodes?: string[];
                  valueDateFrom?: string;
                  valueDateTo?: string;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              values?:
                                  | {
                                      accountId?: ...;
                                      amlDeclineReason?: ...;
                                      amlMonitoringEnabled?: ...;
                                      autoConfirm?: ...;
                                      cancellationRequestStatusCode?: ...;
                                      cancelReason?: ...;
                                      cancelRefuseReason?: ...;
                                      categoryPurposeCode?: ...;
                                      chargeBearer?: ...;
                                      contractSource?: ...;
                                      counterpartyOriginalIban?: ...;
                                      details?: ...;
                                      directionCode?: ...;
                                      endToEndId?: ...;
                                      errorCode?: ...;
                                      fees?: ...;
                                      fileImportLineNumber?: ...;
                                      fxPayment?: ...;
                                      fxPaymentFlag?: ...;
                                      insertedDateTime?: ...;
                                      labels?: ...;
                                      lastStatusRequestDate?: ...;
                                      money?: ...;
                                      paymentCancellationReasonCode?: ...;
                                      paymentId?: ...;
                                      paymentParties?: ...;
                                      paymentSchemeElements?: ...;
                                      paymentServiceProviderCode?: ...;
                                      paymentTypeCode?: ...;
                                      postingDate?: ...;
                                      preferredPaymentScheme?: ...;
                                      purposeCode?: ...;
                                      referenceNumber?: ...;
                                      residencyCountryCode?: ...;
                                      returnComment?: ...;
                                      returnReason?: ...;
                                      returnSettlementDate?: ...;
                                      returnStatusCode?: ...;
                                      selectedPaymentScheme?: ...;
                                      settlementDate?: ...;
                                      settlementErrorCode?: ...;
                                      settlementPaymentScheme?: ...;
                                      settlementStatusCode?: ...;
                                      source?: ...;
                                      statusCode?: ...;
                                      tenantCode?: ...;
                                      uetr?: ...;
                                      valueDate?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find Payment by Account ID

      Finds account payments related to a certain account defined by account ID

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { accountId: string };
            query: {
                amountFrom?: number;
                amountTo?: number;
                cancellationRequestStatusCodes?: string[];
                contractNumber?: string;
                counterpartyAccountNumber?: string;
                currencyCodes?: string[];
                details?: string;
                directionCode?: string;
                isNotSettled?: boolean;
                isSettled?: boolean;
                pageNumber: number;
                pageSize: number;
                paymentId?: string;
                paymentServiceProviderCode?: string;
                paymentTypeCodes?: string[];
                postingDateFrom?: string;
                postingDateTo?: string;
                referenceNumber?: string;
                sourceName?: string;
                sourceRef?: string;
                statusCodes?: string[];
                valueDateFrom?: string;
                valueDateTo?: string;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
        • query: {
              amountFrom?: number;
              amountTo?: number;
              cancellationRequestStatusCodes?: string[];
              contractNumber?: string;
              counterpartyAccountNumber?: string;
              currencyCodes?: string[];
              details?: string;
              directionCode?: string;
              isNotSettled?: boolean;
              isSettled?: boolean;
              pageNumber: number;
              pageSize: number;
              paymentId?: string;
              paymentServiceProviderCode?: string;
              paymentTypeCodes?: string[];
              postingDateFrom?: string;
              postingDateTo?: string;
              referenceNumber?: string;
              sourceName?: string;
              sourceRef?: string;
              statusCodes?: string[];
              valueDateFrom?: string;
              valueDateTo?: string;
          }
          • OptionalamountFrom?: number

            Amount from

          • OptionalamountTo?: number

            Amount to

          • OptionalcancellationRequestStatusCodes?: string[]

            Cancellation request status codes

          • OptionalcontractNumber?: string

            Contract number

          • OptionalcounterpartyAccountNumber?: string

            Counterparty account number

          • OptionalcurrencyCodes?: string[]

            Currency codes

          • Optionaldetails?: string

            Details

          • OptionaldirectionCode?: string

            Direction code

          • OptionalisNotSettled?: boolean

            Is not settled

          • OptionalisSettled?: boolean

            Is settled

          • pageNumber: number

            Page number

          • pageSize: number

            Page size

          • OptionalpaymentId?: string

            Payment ID

          • OptionalpaymentServiceProviderCode?: string

            Payment service provider code

          • OptionalpaymentTypeCodes?: string[]

            Payment type codes

          • OptionalpostingDateFrom?: string

            Posting date from

          • OptionalpostingDateTo?: string

            Posting date to

          • OptionalreferenceNumber?: string

            Reference number

          • OptionalsourceName?: string

            Source name

          • OptionalsourceRef?: string

            Source reference

          • OptionalstatusCodes?: string[]

            Status codes

          • OptionalvalueDateFrom?: string

            Value date from

          • OptionalvalueDateTo?: string

            Value date to

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            values?:
                                | {
                                    accountId?: ...;
                                    amlDeclineReason?: ...;
                                    amlMonitoringEnabled?: ...;
                                    autoConfirm?: ...;
                                    cancellationRequestStatusCode?: ...;
                                    cancelReason?: ...;
                                    cancelRefuseReason?: ...;
                                    categoryPurposeCode?: ...;
                                    chargeBearer?: ...;
                                    contractSource?: ...;
                                    counterpartyOriginalIban?: ...;
                                    details?: ...;
                                    directionCode?: ...;
                                    endToEndId?: ...;
                                    errorCode?: ...;
                                    fees?: ...;
                                    fileImportLineNumber?: ...;
                                    fxPayment?: ...;
                                    fxPaymentFlag?: ...;
                                    insertedDateTime?: ...;
                                    labels?: ...;
                                    lastStatusRequestDate?: ...;
                                    money?: ...;
                                    paymentCancellationReasonCode?: ...;
                                    paymentId?: ...;
                                    paymentParties?: ...;
                                    paymentSchemeElements?: ...;
                                    paymentServiceProviderCode?: ...;
                                    paymentTypeCode?: ...;
                                    postingDate?: ...;
                                    preferredPaymentScheme?: ...;
                                    purposeCode?: ...;
                                    referenceNumber?: ...;
                                    residencyCountryCode?: ...;
                                    returnComment?: ...;
                                    returnReason?: ...;
                                    returnSettlementDate?: ...;
                                    returnStatusCode?: ...;
                                    selectedPaymentScheme?: ...;
                                    settlementDate?: ...;
                                    settlementErrorCode?: ...;
                                    settlementPaymentScheme?: ...;
                                    settlementStatusCode?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    tenantCode?: ...;
                                    uetr?: ...;
                                    valueDate?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          values?:
                              | {
                                  accountId?: ...;
                                  amlDeclineReason?: ...;
                                  amlMonitoringEnabled?: ...;
                                  autoConfirm?: ...;
                                  cancellationRequestStatusCode?: ...;
                                  cancelReason?: ...;
                                  cancelRefuseReason?: ...;
                                  categoryPurposeCode?: ...;
                                  chargeBearer?: ...;
                                  contractSource?: ...;
                                  counterpartyOriginalIban?: ...;
                                  details?: ...;
                                  directionCode?: ...;
                                  endToEndId?: ...;
                                  errorCode?: ...;
                                  fees?: ...;
                                  fileImportLineNumber?: ...;
                                  fxPayment?: ...;
                                  fxPaymentFlag?: ...;
                                  insertedDateTime?: ...;
                                  labels?: ...;
                                  lastStatusRequestDate?: ...;
                                  money?: ...;
                                  paymentCancellationReasonCode?: ...;
                                  paymentId?: ...;
                                  paymentParties?: ...;
                                  paymentSchemeElements?: ...;
                                  paymentServiceProviderCode?: ...;
                                  paymentTypeCode?: ...;
                                  postingDate?: ...;
                                  preferredPaymentScheme?: ...;
                                  purposeCode?: ...;
                                  referenceNumber?: ...;
                                  residencyCountryCode?: ...;
                                  returnComment?: ...;
                                  returnReason?: ...;
                                  returnSettlementDate?: ...;
                                  returnStatusCode?: ...;
                                  selectedPaymentScheme?: ...;
                                  settlementDate?: ...;
                                  settlementErrorCode?: ...;
                                  settlementPaymentScheme?: ...;
                                  settlementStatusCode?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  tenantCode?: ...;
                                  uetr?: ...;
                                  valueDate?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/accounts/by-account-number": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query: {
                    accountNumberSubType: string;
                    accountNumberType: string;
                    accountNumberValue: string;
                    countryCode: string;
                    financialInstitutionIdType: string;
                    financialInstitutionIdValue: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                accountClassCode?: string | null;
                                accountId?: string | null;
                                accountName?: string | null;
                                accountNumbers?:
                                    | {
                                        accountId?: ...;
                                        accountNumber: ...;
                                        accountNumberId?: ...;
                                        accountNumberSubtype?: ...;
                                        countryCode?: ...;
                                        defaultCurrencyCode?: ...;
                                        externalSyncEnabled?: ...;
                                        financialInstitutionId?: ...;
                                        statusCode?: ...;
                                        tenantCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                accountTypeCode?: | "CURRENCY"
                                | "INTERNAL"
                                | "SAVING"
                                | "SHADOW"
                                | "VIRTUAL";
                                accountTypeSetupCode?: string
                                | null;
                                activationDate?: string | null;
                                balances?:
                                    | {
                                        accountId: ...;
                                        availableBalanceAmount?: ...;
                                        availableBalanceInDefaultCcy?: ...;
                                        balanceAmount?: ...;
                                        balanceId: ...;
                                        currencyCode: ...;
                                        defaultCurrencyCode?: ...;
                                        negativeBalanceStartDate?: ...;
                                        overdraftLimitAmount?: ...;
                                        reservedAmount?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                bic?: string
                                | null;
                                counterpartySectorCode?: string | null;
                                customerGroupCode?: string | null;
                                defaultCurrencyCode?: string | null;
                                iban?: string | null;
                                interestMethodAssignmentCode?: string | null;
                                intraOrgCode?: string | null;
                                jurisdictionCountryCode?: string | null;
                                masterAccountId?: string | null;
                                personId?: string | null;
                                personName?: string | null;
                                personTypeCode?: string | null;
                                productCode?: string | null;
                                residencyCode?: string | null;
                                serviceProviderCode?: string | null;
                                source?: { sourceName: string; sourceRef: string };
                                statusCode?:
                                    | "ACTIVE"
                                    | "INACTIVE"
                                    | "CLOSED"
                                    | "CREATED"
                                    | "BLOCKED"
                                    | "WAITING_FOR_CLOSURE_DECISION";
                                statusReasonCode?: string
                                | null;
                                taxResidencyCountryCode?: string | null;
                                tenantCode?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query: {
                  accountNumberSubType: string;
                  accountNumberType: string;
                  accountNumberValue: string;
                  countryCode: string;
                  financialInstitutionIdType: string;
                  financialInstitutionIdValue: string;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              accountClassCode?: string | null;
                              accountId?: string | null;
                              accountName?: string | null;
                              accountNumbers?:
                                  | {
                                      accountId?: ...;
                                      accountNumber: ...;
                                      accountNumberId?: ...;
                                      accountNumberSubtype?: ...;
                                      countryCode?: ...;
                                      defaultCurrencyCode?: ...;
                                      externalSyncEnabled?: ...;
                                      financialInstitutionId?: ...;
                                      statusCode?: ...;
                                      tenantCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              accountTypeCode?: | "CURRENCY"
                              | "INTERNAL"
                              | "SAVING"
                              | "SHADOW"
                              | "VIRTUAL";
                              accountTypeSetupCode?: string
                              | null;
                              activationDate?: string | null;
                              balances?:
                                  | {
                                      accountId: ...;
                                      availableBalanceAmount?: ...;
                                      availableBalanceInDefaultCcy?: ...;
                                      balanceAmount?: ...;
                                      balanceId: ...;
                                      currencyCode: ...;
                                      defaultCurrencyCode?: ...;
                                      negativeBalanceStartDate?: ...;
                                      overdraftLimitAmount?: ...;
                                      reservedAmount?: ...;
                                      tenantCode?: ...;
                                  }[]
                                  | null;
                              bic?: string
                              | null;
                              counterpartySectorCode?: string | null;
                              customerGroupCode?: string | null;
                              defaultCurrencyCode?: string | null;
                              iban?: string | null;
                              interestMethodAssignmentCode?: string | null;
                              intraOrgCode?: string | null;
                              jurisdictionCountryCode?: string | null;
                              masterAccountId?: string | null;
                              personId?: string | null;
                              personName?: string | null;
                              personTypeCode?: string | null;
                              productCode?: string | null;
                              residencyCode?: string | null;
                              serviceProviderCode?: string | null;
                              source?: { sourceName: string; sourceRef: string };
                              statusCode?:
                                  | "ACTIVE"
                                  | "INACTIVE"
                                  | "CLOSED"
                                  | "CREATED"
                                  | "BLOCKED"
                                  | "WAITING_FOR_CLOSURE_DECISION";
                              statusReasonCode?: string
                              | null;
                              taxResidencyCountryCode?: string | null;
                              tenantCode?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find account by master account number

      Finds master account data by account number information.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query: {
                accountNumberSubType: string;
                accountNumberType: string;
                accountNumberValue: string;
                countryCode: string;
                financialInstitutionIdType: string;
                financialInstitutionIdValue: string;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • query: {
              accountNumberSubType: string;
              accountNumberType: string;
              accountNumberValue: string;
              countryCode: string;
              financialInstitutionIdType: string;
              financialInstitutionIdValue: string;
          }
          • accountNumberSubType: string

            Account number sub type

          • accountNumberType: string

            Account number type

          • accountNumberValue: string

            Account number value

          • countryCode: string

            Country code

          • financialInstitutionIdType: string

            Financial institution ID type

          • financialInstitutionIdValue: string

            Financial institution ID value

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            accountClassCode?: string | null;
                            accountId?: string | null;
                            accountName?: string | null;
                            accountNumbers?:
                                | {
                                    accountId?: ...;
                                    accountNumber: ...;
                                    accountNumberId?: ...;
                                    accountNumberSubtype?: ...;
                                    countryCode?: ...;
                                    defaultCurrencyCode?: ...;
                                    externalSyncEnabled?: ...;
                                    financialInstitutionId?: ...;
                                    statusCode?: ...;
                                    tenantCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            accountTypeCode?: | "CURRENCY"
                            | "INTERNAL"
                            | "SAVING"
                            | "SHADOW"
                            | "VIRTUAL";
                            accountTypeSetupCode?: string
                            | null;
                            activationDate?: string | null;
                            balances?:
                                | {
                                    accountId: ...;
                                    availableBalanceAmount?: ...;
                                    availableBalanceInDefaultCcy?: ...;
                                    balanceAmount?: ...;
                                    balanceId: ...;
                                    currencyCode: ...;
                                    defaultCurrencyCode?: ...;
                                    negativeBalanceStartDate?: ...;
                                    overdraftLimitAmount?: ...;
                                    reservedAmount?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                            bic?: string
                            | null;
                            counterpartySectorCode?: string | null;
                            customerGroupCode?: string | null;
                            defaultCurrencyCode?: string | null;
                            iban?: string | null;
                            interestMethodAssignmentCode?: string | null;
                            intraOrgCode?: string | null;
                            jurisdictionCountryCode?: string | null;
                            masterAccountId?: string | null;
                            personId?: string | null;
                            personName?: string | null;
                            personTypeCode?: string | null;
                            productCode?: string | null;
                            residencyCode?: string | null;
                            serviceProviderCode?: string | null;
                            source?: { sourceName: string; sourceRef: string };
                            statusCode?:
                                | "ACTIVE"
                                | "INACTIVE"
                                | "CLOSED"
                                | "CREATED"
                                | "BLOCKED"
                                | "WAITING_FOR_CLOSURE_DECISION";
                            statusReasonCode?: string
                            | null;
                            taxResidencyCountryCode?: string | null;
                            tenantCode?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          accountClassCode?: string | null;
                          accountId?: string | null;
                          accountName?: string | null;
                          accountNumbers?:
                              | {
                                  accountId?: ...;
                                  accountNumber: ...;
                                  accountNumberId?: ...;
                                  accountNumberSubtype?: ...;
                                  countryCode?: ...;
                                  defaultCurrencyCode?: ...;
                                  externalSyncEnabled?: ...;
                                  financialInstitutionId?: ...;
                                  statusCode?: ...;
                                  tenantCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          accountTypeCode?: | "CURRENCY"
                          | "INTERNAL"
                          | "SAVING"
                          | "SHADOW"
                          | "VIRTUAL";
                          accountTypeSetupCode?: string
                          | null;
                          activationDate?: string | null;
                          balances?:
                              | {
                                  accountId: ...;
                                  availableBalanceAmount?: ...;
                                  availableBalanceInDefaultCcy?: ...;
                                  balanceAmount?: ...;
                                  balanceId: ...;
                                  currencyCode: ...;
                                  defaultCurrencyCode?: ...;
                                  negativeBalanceStartDate?: ...;
                                  overdraftLimitAmount?: ...;
                                  reservedAmount?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                          bic?: string
                          | null;
                          counterpartySectorCode?: string | null;
                          customerGroupCode?: string | null;
                          defaultCurrencyCode?: string | null;
                          iban?: string | null;
                          interestMethodAssignmentCode?: string | null;
                          intraOrgCode?: string | null;
                          jurisdictionCountryCode?: string | null;
                          masterAccountId?: string | null;
                          personId?: string | null;
                          personName?: string | null;
                          personTypeCode?: string | null;
                          productCode?: string | null;
                          residencyCode?: string | null;
                          serviceProviderCode?: string | null;
                          source?: { sourceName: string; sourceRef: string };
                          statusCode?:
                              | "ACTIVE"
                              | "INACTIVE"
                              | "CLOSED"
                              | "CREATED"
                              | "BLOCKED"
                              | "WAITING_FOR_CLOSURE_DECISION";
                          statusReasonCode?: string
                          | null;
                          taxResidencyCountryCode?: string | null;
                          tenantCode?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/payments/{paymentId}/cancel": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { paymentId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": { comment?: string
                    | null };
                    "application/json": { comment?: string | null };
                    "text/json": { comment?: string | null };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accountId?: string
                                | null;
                                amlDeclineReason?: string | null;
                                amlMonitoringEnabled?: boolean | null;
                                autoConfirm?: boolean | null;
                                cancellationRequestStatusCode?: string | null;
                                cancelReason?: string | null;
                                cancelRefuseReason?: string | null;
                                categoryPurposeCode?: string | null;
                                chargeBearer?: string | null;
                                contractSource?: {
                                    contractNumber?: (...) | (...);
                                    sourceName?: (...) | (...);
                                    sourceRef?: (...) | (...);
                                };
                                counterpartyOriginalIban?: string
                                | null;
                                details?: string | null;
                                directionCode?: string | null;
                                endToEndId?: string | null;
                                errorCode?: string | null;
                                fees?:
                                    | {
                                        actualFeeMoney?: ...;
                                        deferredFee?: ...;
                                        estimatedFee?: ...;
                                        feeMoney?: ...;
                                        feeTypeCode?: ...;
                                    }[]
                                    | null;
                                fileImportLineNumber?: number
                                | null;
                                fxPayment?: {
                                    coverMoney?: (...) | (...);
                                    exchangeRate?: (...) | (...) | (...);
                                    fixedSide?: (...) | (...) | (...);
                                    fxQuoteRequestId?: (...) | (...) | (...);
                                    paymentMoney?: (...) | (...);
                                    reservationMoney?: (...) | (...);
                                    serviceProviderResult?: (...) | (...);
                                };
                                fxPaymentFlag?: boolean
                                | null;
                                insertedDateTime?: string | null;
                                labels?: string[] | null;
                                lastStatusRequestDate?: string | null;
                                money?: { amount?: (...) | (...); currencyCode: string };
                                paymentCancellationReasonCode?: string | null;
                                paymentId?: string | null;
                                paymentParties?:
                                    | {
                                        accountNumber?: ...;
                                        accountNumberCountryCode?: ...;
                                        accountNumberSubtype?: ...;
                                        address?: ...;
                                        financialInstitutionId?: ...;
                                        givenName?: ...;
                                        name?: ...;
                                        partyIdentification?: ...;
                                        paymentPartyId?: ...;
                                        personTypeCode?: ...;
                                        roleCode?: ...;
                                        surname?: ...;
                                        tenantCode?: ...;
                                        typeCode?: ...;
                                    }[]
                                    | null;
                                paymentSchemeElements?: | {
                                    fieldValue?: ...;
                                    fieldValueCountryCode?: ...;
                                    fieldValueSchemeTypeCode?: ...;
                                    fieldValueTypeCode?: ...;
                                    includeToMetaInfo?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                                paymentServiceProviderCode?: string
                                | null;
                                paymentTypeCode?: string | null;
                                postingDate?: string | null;
                                preferredPaymentScheme?: string | null;
                                purposeCode?: string | null;
                                referenceNumber?: string | null;
                                residencyCountryCode?: string | null;
                                returnComment?: string | null;
                                returnReason?: string | null;
                                returnSettlementDate?: string | null;
                                returnStatusCode?: string | null;
                                selectedPaymentScheme?: string | null;
                                settlementDate?: string | null;
                                settlementErrorCode?: string | null;
                                settlementPaymentScheme?: string | null;
                                settlementStatusCode?: string | null;
                                source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                statusCode?: string | null;
                                tenantCode?: string | null;
                                uetr?: string | null;
                                valueDate?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { paymentId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": { comment?: string
                  | null };
                  "application/json": { comment?: string | null };
                  "text/json": { comment?: string | null };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accountId?: string
                              | null;
                              amlDeclineReason?: string | null;
                              amlMonitoringEnabled?: boolean | null;
                              autoConfirm?: boolean | null;
                              cancellationRequestStatusCode?: string | null;
                              cancelReason?: string | null;
                              cancelRefuseReason?: string | null;
                              categoryPurposeCode?: string | null;
                              chargeBearer?: string | null;
                              contractSource?: {
                                  contractNumber?: (...) | (...);
                                  sourceName?: (...) | (...);
                                  sourceRef?: (...) | (...);
                              };
                              counterpartyOriginalIban?: string
                              | null;
                              details?: string | null;
                              directionCode?: string | null;
                              endToEndId?: string | null;
                              errorCode?: string | null;
                              fees?:
                                  | {
                                      actualFeeMoney?: ...;
                                      deferredFee?: ...;
                                      estimatedFee?: ...;
                                      feeMoney?: ...;
                                      feeTypeCode?: ...;
                                  }[]
                                  | null;
                              fileImportLineNumber?: number
                              | null;
                              fxPayment?: {
                                  coverMoney?: (...) | (...);
                                  exchangeRate?: (...) | (...) | (...);
                                  fixedSide?: (...) | (...) | (...);
                                  fxQuoteRequestId?: (...) | (...) | (...);
                                  paymentMoney?: (...) | (...);
                                  reservationMoney?: (...) | (...);
                                  serviceProviderResult?: (...) | (...);
                              };
                              fxPaymentFlag?: boolean
                              | null;
                              insertedDateTime?: string | null;
                              labels?: string[] | null;
                              lastStatusRequestDate?: string | null;
                              money?: { amount?: (...) | (...); currencyCode: string };
                              paymentCancellationReasonCode?: string | null;
                              paymentId?: string | null;
                              paymentParties?:
                                  | {
                                      accountNumber?: ...;
                                      accountNumberCountryCode?: ...;
                                      accountNumberSubtype?: ...;
                                      address?: ...;
                                      financialInstitutionId?: ...;
                                      givenName?: ...;
                                      name?: ...;
                                      partyIdentification?: ...;
                                      paymentPartyId?: ...;
                                      personTypeCode?: ...;
                                      roleCode?: ...;
                                      surname?: ...;
                                      tenantCode?: ...;
                                      typeCode?: ...;
                                  }[]
                                  | null;
                              paymentSchemeElements?: | {
                                  fieldValue?: ...;
                                  fieldValueCountryCode?: ...;
                                  fieldValueSchemeTypeCode?: ...;
                                  fieldValueTypeCode?: ...;
                                  includeToMetaInfo?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                              paymentServiceProviderCode?: string
                              | null;
                              paymentTypeCode?: string | null;
                              postingDate?: string | null;
                              preferredPaymentScheme?: string | null;
                              purposeCode?: string | null;
                              referenceNumber?: string | null;
                              residencyCountryCode?: string | null;
                              returnComment?: string | null;
                              returnReason?: string | null;
                              returnSettlementDate?: string | null;
                              returnStatusCode?: string | null;
                              selectedPaymentScheme?: string | null;
                              settlementDate?: string | null;
                              settlementErrorCode?: string | null;
                              settlementPaymentScheme?: string | null;
                              settlementStatusCode?: string | null;
                              source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                              statusCode?: string | null;
                              tenantCode?: string | null;
                              uetr?: string | null;
                              valueDate?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Cancel payment

      Initiates account payment cancellation

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { paymentId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string

            Idempotency key

            9539eef2-ddd2-4d0e-99c6-c06b32a879cc
            
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { paymentId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": { comment?: string | null };
                "application/json": { comment?: string | null };
                "text/json": { comment?: string | null };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accountId?: string | null;
                            amlDeclineReason?: string | null;
                            amlMonitoringEnabled?: boolean | null;
                            autoConfirm?: boolean | null;
                            cancellationRequestStatusCode?: string | null;
                            cancelReason?: string | null;
                            cancelRefuseReason?: string | null;
                            categoryPurposeCode?: string | null;
                            chargeBearer?: string | null;
                            contractSource?: {
                                contractNumber?: (...) | (...);
                                sourceName?: (...) | (...);
                                sourceRef?: (...) | (...);
                            };
                            counterpartyOriginalIban?: string
                            | null;
                            details?: string | null;
                            directionCode?: string | null;
                            endToEndId?: string | null;
                            errorCode?: string | null;
                            fees?:
                                | {
                                    actualFeeMoney?: ...;
                                    deferredFee?: ...;
                                    estimatedFee?: ...;
                                    feeMoney?: ...;
                                    feeTypeCode?: ...;
                                }[]
                                | null;
                            fileImportLineNumber?: number
                            | null;
                            fxPayment?: {
                                coverMoney?: (...) | (...);
                                exchangeRate?: (...) | (...) | (...);
                                fixedSide?: (...) | (...) | (...);
                                fxQuoteRequestId?: (...) | (...) | (...);
                                paymentMoney?: (...) | (...);
                                reservationMoney?: (...) | (...);
                                serviceProviderResult?: (...) | (...);
                            };
                            fxPaymentFlag?: boolean
                            | null;
                            insertedDateTime?: string | null;
                            labels?: string[] | null;
                            lastStatusRequestDate?: string | null;
                            money?: { amount?: (...) | (...); currencyCode: string };
                            paymentCancellationReasonCode?: string | null;
                            paymentId?: string | null;
                            paymentParties?:
                                | {
                                    accountNumber?: ...;
                                    accountNumberCountryCode?: ...;
                                    accountNumberSubtype?: ...;
                                    address?: ...;
                                    financialInstitutionId?: ...;
                                    givenName?: ...;
                                    name?: ...;
                                    partyIdentification?: ...;
                                    paymentPartyId?: ...;
                                    personTypeCode?: ...;
                                    roleCode?: ...;
                                    surname?: ...;
                                    tenantCode?: ...;
                                    typeCode?: ...;
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: ...;
                                fieldValueCountryCode?: ...;
                                fieldValueSchemeTypeCode?: ...;
                                fieldValueTypeCode?: ...;
                                includeToMetaInfo?: ...;
                                tenantCode?: ...;
                            }[]
                            | null;
                            paymentServiceProviderCode?: string
                            | null;
                            paymentTypeCode?: string | null;
                            postingDate?: string | null;
                            preferredPaymentScheme?: string | null;
                            purposeCode?: string | null;
                            referenceNumber?: string | null;
                            residencyCountryCode?: string | null;
                            returnComment?: string | null;
                            returnReason?: string | null;
                            returnSettlementDate?: string | null;
                            returnStatusCode?: string | null;
                            selectedPaymentScheme?: string | null;
                            settlementDate?: string | null;
                            settlementErrorCode?: string | null;
                            settlementPaymentScheme?: string | null;
                            settlementStatusCode?: string | null;
                            source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                            statusCode?: string | null;
                            tenantCode?: string | null;
                            uetr?: string | null;
                            valueDate?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accountId?: string | null;
                          amlDeclineReason?: string | null;
                          amlMonitoringEnabled?: boolean | null;
                          autoConfirm?: boolean | null;
                          cancellationRequestStatusCode?: string | null;
                          cancelReason?: string | null;
                          cancelRefuseReason?: string | null;
                          categoryPurposeCode?: string | null;
                          chargeBearer?: string | null;
                          contractSource?: {
                              contractNumber?: (...) | (...);
                              sourceName?: (...) | (...);
                              sourceRef?: (...) | (...);
                          };
                          counterpartyOriginalIban?: string
                          | null;
                          details?: string | null;
                          directionCode?: string | null;
                          endToEndId?: string | null;
                          errorCode?: string | null;
                          fees?:
                              | {
                                  actualFeeMoney?: ...;
                                  deferredFee?: ...;
                                  estimatedFee?: ...;
                                  feeMoney?: ...;
                                  feeTypeCode?: ...;
                              }[]
                              | null;
                          fileImportLineNumber?: number
                          | null;
                          fxPayment?: {
                              coverMoney?: (...) | (...);
                              exchangeRate?: (...) | (...) | (...);
                              fixedSide?: (...) | (...) | (...);
                              fxQuoteRequestId?: (...) | (...) | (...);
                              paymentMoney?: (...) | (...);
                              reservationMoney?: (...) | (...);
                              serviceProviderResult?: (...) | (...);
                          };
                          fxPaymentFlag?: boolean
                          | null;
                          insertedDateTime?: string | null;
                          labels?: string[] | null;
                          lastStatusRequestDate?: string | null;
                          money?: { amount?: (...) | (...); currencyCode: string };
                          paymentCancellationReasonCode?: string | null;
                          paymentId?: string | null;
                          paymentParties?:
                              | {
                                  accountNumber?: ...;
                                  accountNumberCountryCode?: ...;
                                  accountNumberSubtype?: ...;
                                  address?: ...;
                                  financialInstitutionId?: ...;
                                  givenName?: ...;
                                  name?: ...;
                                  partyIdentification?: ...;
                                  paymentPartyId?: ...;
                                  personTypeCode?: ...;
                                  roleCode?: ...;
                                  surname?: ...;
                                  tenantCode?: ...;
                                  typeCode?: ...;
                              }[]
                              | null;
                          paymentSchemeElements?: | {
                              fieldValue?: ...;
                              fieldValueCountryCode?: ...;
                              fieldValueSchemeTypeCode?: ...;
                              fieldValueTypeCode?: ...;
                              includeToMetaInfo?: ...;
                              tenantCode?: ...;
                          }[]
                          | null;
                          paymentServiceProviderCode?: string
                          | null;
                          paymentTypeCode?: string | null;
                          postingDate?: string | null;
                          preferredPaymentScheme?: string | null;
                          purposeCode?: string | null;
                          referenceNumber?: string | null;
                          residencyCountryCode?: string | null;
                          returnComment?: string | null;
                          returnReason?: string | null;
                          returnSettlementDate?: string | null;
                          returnStatusCode?: string | null;
                          selectedPaymentScheme?: string | null;
                          settlementDate?: string | null;
                          settlementErrorCode?: string | null;
                          settlementPaymentScheme?: string | null;
                          settlementStatusCode?: string | null;
                          source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                          statusCode?: string | null;
                          tenantCode?: string | null;
                          uetr?: string | null;
                          valueDate?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/payments/{paymentId}/confirm": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { paymentId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": { comment?: string
                    | null };
                    "application/json": { comment?: string | null };
                    "text/json": { comment?: string | null };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accountId?: string
                                | null;
                                amlDeclineReason?: string | null;
                                amlMonitoringEnabled?: boolean | null;
                                autoConfirm?: boolean | null;
                                cancellationRequestStatusCode?: string | null;
                                cancelReason?: string | null;
                                cancelRefuseReason?: string | null;
                                categoryPurposeCode?: string | null;
                                chargeBearer?: string | null;
                                contractSource?: {
                                    contractNumber?: (...) | (...);
                                    sourceName?: (...) | (...);
                                    sourceRef?: (...) | (...);
                                };
                                counterpartyOriginalIban?: string
                                | null;
                                details?: string | null;
                                directionCode?: string | null;
                                endToEndId?: string | null;
                                errorCode?: string | null;
                                fees?:
                                    | {
                                        actualFeeMoney?: ...;
                                        deferredFee?: ...;
                                        estimatedFee?: ...;
                                        feeMoney?: ...;
                                        feeTypeCode?: ...;
                                    }[]
                                    | null;
                                fileImportLineNumber?: number
                                | null;
                                fxPayment?: {
                                    coverMoney?: (...) | (...);
                                    exchangeRate?: (...) | (...) | (...);
                                    fixedSide?: (...) | (...) | (...);
                                    fxQuoteRequestId?: (...) | (...) | (...);
                                    paymentMoney?: (...) | (...);
                                    reservationMoney?: (...) | (...);
                                    serviceProviderResult?: (...) | (...);
                                };
                                fxPaymentFlag?: boolean
                                | null;
                                insertedDateTime?: string | null;
                                labels?: string[] | null;
                                lastStatusRequestDate?: string | null;
                                money?: { amount?: (...) | (...); currencyCode: string };
                                paymentCancellationReasonCode?: string | null;
                                paymentId?: string | null;
                                paymentParties?:
                                    | {
                                        accountNumber?: ...;
                                        accountNumberCountryCode?: ...;
                                        accountNumberSubtype?: ...;
                                        address?: ...;
                                        financialInstitutionId?: ...;
                                        givenName?: ...;
                                        name?: ...;
                                        partyIdentification?: ...;
                                        paymentPartyId?: ...;
                                        personTypeCode?: ...;
                                        roleCode?: ...;
                                        surname?: ...;
                                        tenantCode?: ...;
                                        typeCode?: ...;
                                    }[]
                                    | null;
                                paymentSchemeElements?: | {
                                    fieldValue?: ...;
                                    fieldValueCountryCode?: ...;
                                    fieldValueSchemeTypeCode?: ...;
                                    fieldValueTypeCode?: ...;
                                    includeToMetaInfo?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                                paymentServiceProviderCode?: string
                                | null;
                                paymentTypeCode?: string | null;
                                postingDate?: string | null;
                                preferredPaymentScheme?: string | null;
                                purposeCode?: string | null;
                                referenceNumber?: string | null;
                                residencyCountryCode?: string | null;
                                returnComment?: string | null;
                                returnReason?: string | null;
                                returnSettlementDate?: string | null;
                                returnStatusCode?: string | null;
                                selectedPaymentScheme?: string | null;
                                settlementDate?: string | null;
                                settlementErrorCode?: string | null;
                                settlementPaymentScheme?: string | null;
                                settlementStatusCode?: string | null;
                                source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                statusCode?: string | null;
                                tenantCode?: string | null;
                                uetr?: string | null;
                                valueDate?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { paymentId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": { comment?: string
                  | null };
                  "application/json": { comment?: string | null };
                  "text/json": { comment?: string | null };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accountId?: string
                              | null;
                              amlDeclineReason?: string | null;
                              amlMonitoringEnabled?: boolean | null;
                              autoConfirm?: boolean | null;
                              cancellationRequestStatusCode?: string | null;
                              cancelReason?: string | null;
                              cancelRefuseReason?: string | null;
                              categoryPurposeCode?: string | null;
                              chargeBearer?: string | null;
                              contractSource?: {
                                  contractNumber?: (...) | (...);
                                  sourceName?: (...) | (...);
                                  sourceRef?: (...) | (...);
                              };
                              counterpartyOriginalIban?: string
                              | null;
                              details?: string | null;
                              directionCode?: string | null;
                              endToEndId?: string | null;
                              errorCode?: string | null;
                              fees?:
                                  | {
                                      actualFeeMoney?: ...;
                                      deferredFee?: ...;
                                      estimatedFee?: ...;
                                      feeMoney?: ...;
                                      feeTypeCode?: ...;
                                  }[]
                                  | null;
                              fileImportLineNumber?: number
                              | null;
                              fxPayment?: {
                                  coverMoney?: (...) | (...);
                                  exchangeRate?: (...) | (...) | (...);
                                  fixedSide?: (...) | (...) | (...);
                                  fxQuoteRequestId?: (...) | (...) | (...);
                                  paymentMoney?: (...) | (...);
                                  reservationMoney?: (...) | (...);
                                  serviceProviderResult?: (...) | (...);
                              };
                              fxPaymentFlag?: boolean
                              | null;
                              insertedDateTime?: string | null;
                              labels?: string[] | null;
                              lastStatusRequestDate?: string | null;
                              money?: { amount?: (...) | (...); currencyCode: string };
                              paymentCancellationReasonCode?: string | null;
                              paymentId?: string | null;
                              paymentParties?:
                                  | {
                                      accountNumber?: ...;
                                      accountNumberCountryCode?: ...;
                                      accountNumberSubtype?: ...;
                                      address?: ...;
                                      financialInstitutionId?: ...;
                                      givenName?: ...;
                                      name?: ...;
                                      partyIdentification?: ...;
                                      paymentPartyId?: ...;
                                      personTypeCode?: ...;
                                      roleCode?: ...;
                                      surname?: ...;
                                      tenantCode?: ...;
                                      typeCode?: ...;
                                  }[]
                                  | null;
                              paymentSchemeElements?: | {
                                  fieldValue?: ...;
                                  fieldValueCountryCode?: ...;
                                  fieldValueSchemeTypeCode?: ...;
                                  fieldValueTypeCode?: ...;
                                  includeToMetaInfo?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                              paymentServiceProviderCode?: string
                              | null;
                              paymentTypeCode?: string | null;
                              postingDate?: string | null;
                              preferredPaymentScheme?: string | null;
                              purposeCode?: string | null;
                              referenceNumber?: string | null;
                              residencyCountryCode?: string | null;
                              returnComment?: string | null;
                              returnReason?: string | null;
                              returnSettlementDate?: string | null;
                              returnStatusCode?: string | null;
                              selectedPaymentScheme?: string | null;
                              settlementDate?: string | null;
                              settlementErrorCode?: string | null;
                              settlementPaymentScheme?: string | null;
                              settlementStatusCode?: string | null;
                              source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                              statusCode?: string | null;
                              tenantCode?: string | null;
                              uetr?: string | null;
                              valueDate?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Confirm payment

      Confirms a payment from a specified account

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { paymentId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string

            Idempotency key

            9539eef2-ddd2-4d0e-99c6-c06b32a879cc
            
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { paymentId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": { comment?: string | null };
                "application/json": { comment?: string | null };
                "text/json": { comment?: string | null };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accountId?: string | null;
                            amlDeclineReason?: string | null;
                            amlMonitoringEnabled?: boolean | null;
                            autoConfirm?: boolean | null;
                            cancellationRequestStatusCode?: string | null;
                            cancelReason?: string | null;
                            cancelRefuseReason?: string | null;
                            categoryPurposeCode?: string | null;
                            chargeBearer?: string | null;
                            contractSource?: {
                                contractNumber?: (...) | (...);
                                sourceName?: (...) | (...);
                                sourceRef?: (...) | (...);
                            };
                            counterpartyOriginalIban?: string
                            | null;
                            details?: string | null;
                            directionCode?: string | null;
                            endToEndId?: string | null;
                            errorCode?: string | null;
                            fees?:
                                | {
                                    actualFeeMoney?: ...;
                                    deferredFee?: ...;
                                    estimatedFee?: ...;
                                    feeMoney?: ...;
                                    feeTypeCode?: ...;
                                }[]
                                | null;
                            fileImportLineNumber?: number
                            | null;
                            fxPayment?: {
                                coverMoney?: (...) | (...);
                                exchangeRate?: (...) | (...) | (...);
                                fixedSide?: (...) | (...) | (...);
                                fxQuoteRequestId?: (...) | (...) | (...);
                                paymentMoney?: (...) | (...);
                                reservationMoney?: (...) | (...);
                                serviceProviderResult?: (...) | (...);
                            };
                            fxPaymentFlag?: boolean
                            | null;
                            insertedDateTime?: string | null;
                            labels?: string[] | null;
                            lastStatusRequestDate?: string | null;
                            money?: { amount?: (...) | (...); currencyCode: string };
                            paymentCancellationReasonCode?: string | null;
                            paymentId?: string | null;
                            paymentParties?:
                                | {
                                    accountNumber?: ...;
                                    accountNumberCountryCode?: ...;
                                    accountNumberSubtype?: ...;
                                    address?: ...;
                                    financialInstitutionId?: ...;
                                    givenName?: ...;
                                    name?: ...;
                                    partyIdentification?: ...;
                                    paymentPartyId?: ...;
                                    personTypeCode?: ...;
                                    roleCode?: ...;
                                    surname?: ...;
                                    tenantCode?: ...;
                                    typeCode?: ...;
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: ...;
                                fieldValueCountryCode?: ...;
                                fieldValueSchemeTypeCode?: ...;
                                fieldValueTypeCode?: ...;
                                includeToMetaInfo?: ...;
                                tenantCode?: ...;
                            }[]
                            | null;
                            paymentServiceProviderCode?: string
                            | null;
                            paymentTypeCode?: string | null;
                            postingDate?: string | null;
                            preferredPaymentScheme?: string | null;
                            purposeCode?: string | null;
                            referenceNumber?: string | null;
                            residencyCountryCode?: string | null;
                            returnComment?: string | null;
                            returnReason?: string | null;
                            returnSettlementDate?: string | null;
                            returnStatusCode?: string | null;
                            selectedPaymentScheme?: string | null;
                            settlementDate?: string | null;
                            settlementErrorCode?: string | null;
                            settlementPaymentScheme?: string | null;
                            settlementStatusCode?: string | null;
                            source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                            statusCode?: string | null;
                            tenantCode?: string | null;
                            uetr?: string | null;
                            valueDate?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accountId?: string | null;
                          amlDeclineReason?: string | null;
                          amlMonitoringEnabled?: boolean | null;
                          autoConfirm?: boolean | null;
                          cancellationRequestStatusCode?: string | null;
                          cancelReason?: string | null;
                          cancelRefuseReason?: string | null;
                          categoryPurposeCode?: string | null;
                          chargeBearer?: string | null;
                          contractSource?: {
                              contractNumber?: (...) | (...);
                              sourceName?: (...) | (...);
                              sourceRef?: (...) | (...);
                          };
                          counterpartyOriginalIban?: string
                          | null;
                          details?: string | null;
                          directionCode?: string | null;
                          endToEndId?: string | null;
                          errorCode?: string | null;
                          fees?:
                              | {
                                  actualFeeMoney?: ...;
                                  deferredFee?: ...;
                                  estimatedFee?: ...;
                                  feeMoney?: ...;
                                  feeTypeCode?: ...;
                              }[]
                              | null;
                          fileImportLineNumber?: number
                          | null;
                          fxPayment?: {
                              coverMoney?: (...) | (...);
                              exchangeRate?: (...) | (...) | (...);
                              fixedSide?: (...) | (...) | (...);
                              fxQuoteRequestId?: (...) | (...) | (...);
                              paymentMoney?: (...) | (...);
                              reservationMoney?: (...) | (...);
                              serviceProviderResult?: (...) | (...);
                          };
                          fxPaymentFlag?: boolean
                          | null;
                          insertedDateTime?: string | null;
                          labels?: string[] | null;
                          lastStatusRequestDate?: string | null;
                          money?: { amount?: (...) | (...); currencyCode: string };
                          paymentCancellationReasonCode?: string | null;
                          paymentId?: string | null;
                          paymentParties?:
                              | {
                                  accountNumber?: ...;
                                  accountNumberCountryCode?: ...;
                                  accountNumberSubtype?: ...;
                                  address?: ...;
                                  financialInstitutionId?: ...;
                                  givenName?: ...;
                                  name?: ...;
                                  partyIdentification?: ...;
                                  paymentPartyId?: ...;
                                  personTypeCode?: ...;
                                  roleCode?: ...;
                                  surname?: ...;
                                  tenantCode?: ...;
                                  typeCode?: ...;
                              }[]
                              | null;
                          paymentSchemeElements?: | {
                              fieldValue?: ...;
                              fieldValueCountryCode?: ...;
                              fieldValueSchemeTypeCode?: ...;
                              fieldValueTypeCode?: ...;
                              includeToMetaInfo?: ...;
                              tenantCode?: ...;
                          }[]
                          | null;
                          paymentServiceProviderCode?: string
                          | null;
                          paymentTypeCode?: string | null;
                          postingDate?: string | null;
                          preferredPaymentScheme?: string | null;
                          purposeCode?: string | null;
                          referenceNumber?: string | null;
                          residencyCountryCode?: string | null;
                          returnComment?: string | null;
                          returnReason?: string | null;
                          returnSettlementDate?: string | null;
                          returnStatusCode?: string | null;
                          selectedPaymentScheme?: string | null;
                          settlementDate?: string | null;
                          settlementErrorCode?: string | null;
                          settlementPaymentScheme?: string | null;
                          settlementStatusCode?: string | null;
                          source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                          statusCode?: string | null;
                          tenantCode?: string | null;
                          uetr?: string | null;
                          valueDate?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/payments/initialise": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        chargeBearer?: "DEBT";
                        details: string;
                        directionCode: string;
                        endToEndId?: string
                        | null;
                        money: { amount: number; currencyCode: "USD" };
                        paymentParties?:
                            | {
                                accountId?: string
                                | null;
                                accountNumber?: { type: ...; value?: ... };
                                accountNumberCountryCode?: string | null;
                                accountNumberSubtype?: string | null;
                                address?: {
                                    addressLine?: ...;
                                    addressTypeCode?: ...;
                                    cityCounty: ...;
                                    countryCode: ...;
                                    stateRegion?: ...;
                                    street1: ...;
                                    street2?: ...;
                                    zip?: ...;
                                };
                                financialInstitutionId?: string
                                | null;
                                givenName?: string | null;
                                name?: string | null;
                                partyIdentification?: {
                                    identificationTypeCode?: ...;
                                    identificationValue?: ...;
                                };
                                personTypeCode?: "P"
                                | "L";
                                surname?: string | null;
                                typeCode?:
                                    | "OUR_PARTY"
                                    | "OUR_CORRESPONDENT"
                                    | "COUNTERPARTY"
                                    | "ORIGINAL_OUR_PARTY"
                                    | "OUR_PARTY_MASTER";
                            }[]
                            | null;
                        paymentSchemeElements?: | {
                            fieldValue?: string
                            | null;
                            fieldValueCountryCode?: string | null;
                            fieldValueTypeCode?: string;
                            includeToMetaInfo?: string | null;
                        }[]
                        | null;
                        paymentTypeCode: "ACC2EXTERNAL"
                        | "ACC2ACC";
                        preferredPaymentScheme?:
                            | "LOCAL_US_ACH"
                            | "SWIFT_CROSSBORDER"
                            | "LOCAL_US_WIRE"
                            | "LOCAL_STABLECOIN";
                        purposeCode: string;
                        referenceNumber?: string
                        | null;
                        valueDate?: string | null;
                    };
                    "application/json": {
                        chargeBearer?: "DEBT";
                        details: string;
                        directionCode: string;
                        endToEndId?: string
                        | null;
                        money: { amount: number; currencyCode: "USD" };
                        paymentParties?:
                            | {
                                accountId?: string
                                | null;
                                accountNumber?: { type: ...; value?: ... };
                                accountNumberCountryCode?: string | null;
                                accountNumberSubtype?: string | null;
                                address?: {
                                    addressLine?: ...;
                                    addressTypeCode?: ...;
                                    cityCounty: ...;
                                    countryCode: ...;
                                    stateRegion?: ...;
                                    street1: ...;
                                    street2?: ...;
                                    zip?: ...;
                                };
                                financialInstitutionId?: string
                                | null;
                                givenName?: string | null;
                                name?: string | null;
                                partyIdentification?: {
                                    identificationTypeCode?: ...;
                                    identificationValue?: ...;
                                };
                                personTypeCode?: "P"
                                | "L";
                                surname?: string | null;
                                typeCode?:
                                    | "OUR_PARTY"
                                    | "OUR_CORRESPONDENT"
                                    | "COUNTERPARTY"
                                    | "ORIGINAL_OUR_PARTY"
                                    | "OUR_PARTY_MASTER";
                            }[]
                            | null;
                        paymentSchemeElements?: | {
                            fieldValue?: string
                            | null;
                            fieldValueCountryCode?: string | null;
                            fieldValueTypeCode?: string;
                            includeToMetaInfo?: string | null;
                        }[]
                        | null;
                        paymentTypeCode: "ACC2EXTERNAL"
                        | "ACC2ACC";
                        preferredPaymentScheme?:
                            | "LOCAL_US_ACH"
                            | "SWIFT_CROSSBORDER"
                            | "LOCAL_US_WIRE"
                            | "LOCAL_STABLECOIN";
                        purposeCode: string;
                        referenceNumber?: string
                        | null;
                        valueDate?: string | null;
                    };
                    "text/json": {
                        chargeBearer?: "DEBT";
                        details: string;
                        directionCode: string;
                        endToEndId?: string
                        | null;
                        money: { amount: number; currencyCode: "USD" };
                        paymentParties?:
                            | {
                                accountId?: string
                                | null;
                                accountNumber?: { type: ...; value?: ... };
                                accountNumberCountryCode?: string | null;
                                accountNumberSubtype?: string | null;
                                address?: {
                                    addressLine?: ...;
                                    addressTypeCode?: ...;
                                    cityCounty: ...;
                                    countryCode: ...;
                                    stateRegion?: ...;
                                    street1: ...;
                                    street2?: ...;
                                    zip?: ...;
                                };
                                financialInstitutionId?: string
                                | null;
                                givenName?: string | null;
                                name?: string | null;
                                partyIdentification?: {
                                    identificationTypeCode?: ...;
                                    identificationValue?: ...;
                                };
                                personTypeCode?: "P"
                                | "L";
                                surname?: string | null;
                                typeCode?:
                                    | "OUR_PARTY"
                                    | "OUR_CORRESPONDENT"
                                    | "COUNTERPARTY"
                                    | "ORIGINAL_OUR_PARTY"
                                    | "OUR_PARTY_MASTER";
                            }[]
                            | null;
                        paymentSchemeElements?: | {
                            fieldValue?: string
                            | null;
                            fieldValueCountryCode?: string | null;
                            fieldValueTypeCode?: string;
                            includeToMetaInfo?: string | null;
                        }[]
                        | null;
                        paymentTypeCode: "ACC2EXTERNAL"
                        | "ACC2ACC";
                        preferredPaymentScheme?:
                            | "LOCAL_US_ACH"
                            | "SWIFT_CROSSBORDER"
                            | "LOCAL_US_WIRE"
                            | "LOCAL_STABLECOIN";
                        purposeCode: string;
                        referenceNumber?: string
                        | null;
                        valueDate?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accountId?: string
                                | null;
                                amlDeclineReason?: string | null;
                                amlMonitoringEnabled?: boolean | null;
                                autoConfirm?: boolean | null;
                                cancellationRequestStatusCode?: string | null;
                                cancelReason?: string | null;
                                cancelRefuseReason?: string | null;
                                categoryPurposeCode?: string | null;
                                chargeBearer?: string | null;
                                contractSource?: {
                                    contractNumber?: (...) | (...);
                                    sourceName?: (...) | (...);
                                    sourceRef?: (...) | (...);
                                };
                                counterpartyOriginalIban?: string
                                | null;
                                details?: string | null;
                                directionCode?: string | null;
                                endToEndId?: string | null;
                                errorCode?: string | null;
                                fees?:
                                    | {
                                        actualFeeMoney?: ...;
                                        deferredFee?: ...;
                                        estimatedFee?: ...;
                                        feeMoney?: ...;
                                        feeTypeCode?: ...;
                                    }[]
                                    | null;
                                fileImportLineNumber?: number
                                | null;
                                fxPayment?: {
                                    coverMoney?: (...) | (...);
                                    exchangeRate?: (...) | (...) | (...);
                                    fixedSide?: (...) | (...) | (...);
                                    fxQuoteRequestId?: (...) | (...) | (...);
                                    paymentMoney?: (...) | (...);
                                    reservationMoney?: (...) | (...);
                                    serviceProviderResult?: (...) | (...);
                                };
                                fxPaymentFlag?: boolean
                                | null;
                                insertedDateTime?: string | null;
                                labels?: string[] | null;
                                lastStatusRequestDate?: string | null;
                                money?: { amount?: (...) | (...); currencyCode: string };
                                paymentCancellationReasonCode?: string | null;
                                paymentId?: string | null;
                                paymentParties?:
                                    | {
                                        accountNumber?: ...;
                                        accountNumberCountryCode?: ...;
                                        accountNumberSubtype?: ...;
                                        address?: ...;
                                        financialInstitutionId?: ...;
                                        givenName?: ...;
                                        name?: ...;
                                        partyIdentification?: ...;
                                        paymentPartyId?: ...;
                                        personTypeCode?: ...;
                                        roleCode?: ...;
                                        surname?: ...;
                                        tenantCode?: ...;
                                        typeCode?: ...;
                                    }[]
                                    | null;
                                paymentSchemeElements?: | {
                                    fieldValue?: ...;
                                    fieldValueCountryCode?: ...;
                                    fieldValueSchemeTypeCode?: ...;
                                    fieldValueTypeCode?: ...;
                                    includeToMetaInfo?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                                paymentServiceProviderCode?: string
                                | null;
                                paymentTypeCode?: string | null;
                                postingDate?: string | null;
                                preferredPaymentScheme?: string | null;
                                purposeCode?: string | null;
                                referenceNumber?: string | null;
                                residencyCountryCode?: string | null;
                                returnComment?: string | null;
                                returnReason?: string | null;
                                returnSettlementDate?: string | null;
                                returnStatusCode?: string | null;
                                selectedPaymentScheme?: string | null;
                                settlementDate?: string | null;
                                settlementErrorCode?: string | null;
                                settlementPaymentScheme?: string | null;
                                settlementStatusCode?: string | null;
                                source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                                statusCode?: string | null;
                                tenantCode?: string | null;
                                uetr?: string | null;
                                valueDate?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      chargeBearer?: "DEBT";
                      details: string;
                      directionCode: string;
                      endToEndId?: string
                      | null;
                      money: { amount: number; currencyCode: "USD" };
                      paymentParties?:
                          | {
                              accountId?: string
                              | null;
                              accountNumber?: { type: ...; value?: ... };
                              accountNumberCountryCode?: string | null;
                              accountNumberSubtype?: string | null;
                              address?: {
                                  addressLine?: ...;
                                  addressTypeCode?: ...;
                                  cityCounty: ...;
                                  countryCode: ...;
                                  stateRegion?: ...;
                                  street1: ...;
                                  street2?: ...;
                                  zip?: ...;
                              };
                              financialInstitutionId?: string
                              | null;
                              givenName?: string | null;
                              name?: string | null;
                              partyIdentification?: {
                                  identificationTypeCode?: ...;
                                  identificationValue?: ...;
                              };
                              personTypeCode?: "P"
                              | "L";
                              surname?: string | null;
                              typeCode?:
                                  | "OUR_PARTY"
                                  | "OUR_CORRESPONDENT"
                                  | "COUNTERPARTY"
                                  | "ORIGINAL_OUR_PARTY"
                                  | "OUR_PARTY_MASTER";
                          }[]
                          | null;
                      paymentSchemeElements?: | {
                          fieldValue?: string
                          | null;
                          fieldValueCountryCode?: string | null;
                          fieldValueTypeCode?: string;
                          includeToMetaInfo?: string | null;
                      }[]
                      | null;
                      paymentTypeCode: "ACC2EXTERNAL"
                      | "ACC2ACC";
                      preferredPaymentScheme?:
                          | "LOCAL_US_ACH"
                          | "SWIFT_CROSSBORDER"
                          | "LOCAL_US_WIRE"
                          | "LOCAL_STABLECOIN";
                      purposeCode: string;
                      referenceNumber?: string
                      | null;
                      valueDate?: string | null;
                  };
                  "application/json": {
                      chargeBearer?: "DEBT";
                      details: string;
                      directionCode: string;
                      endToEndId?: string
                      | null;
                      money: { amount: number; currencyCode: "USD" };
                      paymentParties?:
                          | {
                              accountId?: string
                              | null;
                              accountNumber?: { type: ...; value?: ... };
                              accountNumberCountryCode?: string | null;
                              accountNumberSubtype?: string | null;
                              address?: {
                                  addressLine?: ...;
                                  addressTypeCode?: ...;
                                  cityCounty: ...;
                                  countryCode: ...;
                                  stateRegion?: ...;
                                  street1: ...;
                                  street2?: ...;
                                  zip?: ...;
                              };
                              financialInstitutionId?: string
                              | null;
                              givenName?: string | null;
                              name?: string | null;
                              partyIdentification?: {
                                  identificationTypeCode?: ...;
                                  identificationValue?: ...;
                              };
                              personTypeCode?: "P"
                              | "L";
                              surname?: string | null;
                              typeCode?:
                                  | "OUR_PARTY"
                                  | "OUR_CORRESPONDENT"
                                  | "COUNTERPARTY"
                                  | "ORIGINAL_OUR_PARTY"
                                  | "OUR_PARTY_MASTER";
                          }[]
                          | null;
                      paymentSchemeElements?: | {
                          fieldValue?: string
                          | null;
                          fieldValueCountryCode?: string | null;
                          fieldValueTypeCode?: string;
                          includeToMetaInfo?: string | null;
                      }[]
                      | null;
                      paymentTypeCode: "ACC2EXTERNAL"
                      | "ACC2ACC";
                      preferredPaymentScheme?:
                          | "LOCAL_US_ACH"
                          | "SWIFT_CROSSBORDER"
                          | "LOCAL_US_WIRE"
                          | "LOCAL_STABLECOIN";
                      purposeCode: string;
                      referenceNumber?: string
                      | null;
                      valueDate?: string | null;
                  };
                  "text/json": {
                      chargeBearer?: "DEBT";
                      details: string;
                      directionCode: string;
                      endToEndId?: string
                      | null;
                      money: { amount: number; currencyCode: "USD" };
                      paymentParties?:
                          | {
                              accountId?: string
                              | null;
                              accountNumber?: { type: ...; value?: ... };
                              accountNumberCountryCode?: string | null;
                              accountNumberSubtype?: string | null;
                              address?: {
                                  addressLine?: ...;
                                  addressTypeCode?: ...;
                                  cityCounty: ...;
                                  countryCode: ...;
                                  stateRegion?: ...;
                                  street1: ...;
                                  street2?: ...;
                                  zip?: ...;
                              };
                              financialInstitutionId?: string
                              | null;
                              givenName?: string | null;
                              name?: string | null;
                              partyIdentification?: {
                                  identificationTypeCode?: ...;
                                  identificationValue?: ...;
                              };
                              personTypeCode?: "P"
                              | "L";
                              surname?: string | null;
                              typeCode?:
                                  | "OUR_PARTY"
                                  | "OUR_CORRESPONDENT"
                                  | "COUNTERPARTY"
                                  | "ORIGINAL_OUR_PARTY"
                                  | "OUR_PARTY_MASTER";
                          }[]
                          | null;
                      paymentSchemeElements?: | {
                          fieldValue?: string
                          | null;
                          fieldValueCountryCode?: string | null;
                          fieldValueTypeCode?: string;
                          includeToMetaInfo?: string | null;
                      }[]
                      | null;
                      paymentTypeCode: "ACC2EXTERNAL"
                      | "ACC2ACC";
                      preferredPaymentScheme?:
                          | "LOCAL_US_ACH"
                          | "SWIFT_CROSSBORDER"
                          | "LOCAL_US_WIRE"
                          | "LOCAL_STABLECOIN";
                      purposeCode: string;
                      referenceNumber?: string
                      | null;
                      valueDate?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accountId?: string
                              | null;
                              amlDeclineReason?: string | null;
                              amlMonitoringEnabled?: boolean | null;
                              autoConfirm?: boolean | null;
                              cancellationRequestStatusCode?: string | null;
                              cancelReason?: string | null;
                              cancelRefuseReason?: string | null;
                              categoryPurposeCode?: string | null;
                              chargeBearer?: string | null;
                              contractSource?: {
                                  contractNumber?: (...) | (...);
                                  sourceName?: (...) | (...);
                                  sourceRef?: (...) | (...);
                              };
                              counterpartyOriginalIban?: string
                              | null;
                              details?: string | null;
                              directionCode?: string | null;
                              endToEndId?: string | null;
                              errorCode?: string | null;
                              fees?:
                                  | {
                                      actualFeeMoney?: ...;
                                      deferredFee?: ...;
                                      estimatedFee?: ...;
                                      feeMoney?: ...;
                                      feeTypeCode?: ...;
                                  }[]
                                  | null;
                              fileImportLineNumber?: number
                              | null;
                              fxPayment?: {
                                  coverMoney?: (...) | (...);
                                  exchangeRate?: (...) | (...) | (...);
                                  fixedSide?: (...) | (...) | (...);
                                  fxQuoteRequestId?: (...) | (...) | (...);
                                  paymentMoney?: (...) | (...);
                                  reservationMoney?: (...) | (...);
                                  serviceProviderResult?: (...) | (...);
                              };
                              fxPaymentFlag?: boolean
                              | null;
                              insertedDateTime?: string | null;
                              labels?: string[] | null;
                              lastStatusRequestDate?: string | null;
                              money?: { amount?: (...) | (...); currencyCode: string };
                              paymentCancellationReasonCode?: string | null;
                              paymentId?: string | null;
                              paymentParties?:
                                  | {
                                      accountNumber?: ...;
                                      accountNumberCountryCode?: ...;
                                      accountNumberSubtype?: ...;
                                      address?: ...;
                                      financialInstitutionId?: ...;
                                      givenName?: ...;
                                      name?: ...;
                                      partyIdentification?: ...;
                                      paymentPartyId?: ...;
                                      personTypeCode?: ...;
                                      roleCode?: ...;
                                      surname?: ...;
                                      tenantCode?: ...;
                                      typeCode?: ...;
                                  }[]
                                  | null;
                              paymentSchemeElements?: | {
                                  fieldValue?: ...;
                                  fieldValueCountryCode?: ...;
                                  fieldValueSchemeTypeCode?: ...;
                                  fieldValueTypeCode?: ...;
                                  includeToMetaInfo?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                              paymentServiceProviderCode?: string
                              | null;
                              paymentTypeCode?: string | null;
                              postingDate?: string | null;
                              preferredPaymentScheme?: string | null;
                              purposeCode?: string | null;
                              referenceNumber?: string | null;
                              residencyCountryCode?: string | null;
                              returnComment?: string | null;
                              returnReason?: string | null;
                              returnSettlementDate?: string | null;
                              returnStatusCode?: string | null;
                              selectedPaymentScheme?: string | null;
                              settlementDate?: string | null;
                              settlementErrorCode?: string | null;
                              settlementPaymentScheme?: string | null;
                              settlementStatusCode?: string | null;
                              source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                              statusCode?: string | null;
                              tenantCode?: string | null;
                              uetr?: string | null;
                              valueDate?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Initialize ACH/SWIFT payment

      Creates a new ACH/SWIFT payment from OUR_PARTY account

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string

            Idempotency key

            9539eef2-ddd2-4d0e-99c6-c06b32a879cc
            
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    chargeBearer?: "DEBT";
                    details: string;
                    directionCode: string;
                    endToEndId?: string | null;
                    money: { amount: number; currencyCode: "USD" };
                    paymentParties?:
                        | {
                            accountId?: string
                            | null;
                            accountNumber?: { type: ...; value?: ... };
                            accountNumberCountryCode?: string | null;
                            accountNumberSubtype?: string | null;
                            address?: {
                                addressLine?: ...;
                                addressTypeCode?: ...;
                                cityCounty: ...;
                                countryCode: ...;
                                stateRegion?: ...;
                                street1: ...;
                                street2?: ...;
                                zip?: ...;
                            };
                            financialInstitutionId?: string
                            | null;
                            givenName?: string | null;
                            name?: string | null;
                            partyIdentification?: {
                                identificationTypeCode?: ...;
                                identificationValue?: ...;
                            };
                            personTypeCode?: "P"
                            | "L";
                            surname?: string | null;
                            typeCode?:
                                | "OUR_PARTY"
                                | "OUR_CORRESPONDENT"
                                | "COUNTERPARTY"
                                | "ORIGINAL_OUR_PARTY"
                                | "OUR_PARTY_MASTER";
                        }[]
                        | null;
                    paymentSchemeElements?: | {
                        fieldValue?: string
                        | null;
                        fieldValueCountryCode?: string | null;
                        fieldValueTypeCode?: string;
                        includeToMetaInfo?: string | null;
                    }[]
                    | null;
                    paymentTypeCode: "ACC2EXTERNAL"
                    | "ACC2ACC";
                    preferredPaymentScheme?:
                        | "LOCAL_US_ACH"
                        | "SWIFT_CROSSBORDER"
                        | "LOCAL_US_WIRE"
                        | "LOCAL_STABLECOIN";
                    purposeCode: string;
                    referenceNumber?: string
                    | null;
                    valueDate?: string | null;
                };
                "application/json": {
                    chargeBearer?: "DEBT";
                    details: string;
                    directionCode: string;
                    endToEndId?: string
                    | null;
                    money: { amount: number; currencyCode: "USD" };
                    paymentParties?:
                        | {
                            accountId?: string
                            | null;
                            accountNumber?: { type: ...; value?: ... };
                            accountNumberCountryCode?: string | null;
                            accountNumberSubtype?: string | null;
                            address?: {
                                addressLine?: ...;
                                addressTypeCode?: ...;
                                cityCounty: ...;
                                countryCode: ...;
                                stateRegion?: ...;
                                street1: ...;
                                street2?: ...;
                                zip?: ...;
                            };
                            financialInstitutionId?: string
                            | null;
                            givenName?: string | null;
                            name?: string | null;
                            partyIdentification?: {
                                identificationTypeCode?: ...;
                                identificationValue?: ...;
                            };
                            personTypeCode?: "P"
                            | "L";
                            surname?: string | null;
                            typeCode?:
                                | "OUR_PARTY"
                                | "OUR_CORRESPONDENT"
                                | "COUNTERPARTY"
                                | "ORIGINAL_OUR_PARTY"
                                | "OUR_PARTY_MASTER";
                        }[]
                        | null;
                    paymentSchemeElements?: | {
                        fieldValue?: string
                        | null;
                        fieldValueCountryCode?: string | null;
                        fieldValueTypeCode?: string;
                        includeToMetaInfo?: string | null;
                    }[]
                    | null;
                    paymentTypeCode: "ACC2EXTERNAL"
                    | "ACC2ACC";
                    preferredPaymentScheme?:
                        | "LOCAL_US_ACH"
                        | "SWIFT_CROSSBORDER"
                        | "LOCAL_US_WIRE"
                        | "LOCAL_STABLECOIN";
                    purposeCode: string;
                    referenceNumber?: string
                    | null;
                    valueDate?: string | null;
                };
                "text/json": {
                    chargeBearer?: "DEBT";
                    details: string;
                    directionCode: string;
                    endToEndId?: string
                    | null;
                    money: { amount: number; currencyCode: "USD" };
                    paymentParties?:
                        | {
                            accountId?: string
                            | null;
                            accountNumber?: { type: ...; value?: ... };
                            accountNumberCountryCode?: string | null;
                            accountNumberSubtype?: string | null;
                            address?: {
                                addressLine?: ...;
                                addressTypeCode?: ...;
                                cityCounty: ...;
                                countryCode: ...;
                                stateRegion?: ...;
                                street1: ...;
                                street2?: ...;
                                zip?: ...;
                            };
                            financialInstitutionId?: string
                            | null;
                            givenName?: string | null;
                            name?: string | null;
                            partyIdentification?: {
                                identificationTypeCode?: ...;
                                identificationValue?: ...;
                            };
                            personTypeCode?: "P"
                            | "L";
                            surname?: string | null;
                            typeCode?:
                                | "OUR_PARTY"
                                | "OUR_CORRESPONDENT"
                                | "COUNTERPARTY"
                                | "ORIGINAL_OUR_PARTY"
                                | "OUR_PARTY_MASTER";
                        }[]
                        | null;
                    paymentSchemeElements?: | {
                        fieldValue?: string
                        | null;
                        fieldValueCountryCode?: string | null;
                        fieldValueTypeCode?: string;
                        includeToMetaInfo?: string | null;
                    }[]
                    | null;
                    paymentTypeCode: "ACC2EXTERNAL"
                    | "ACC2ACC";
                    preferredPaymentScheme?:
                        | "LOCAL_US_ACH"
                        | "SWIFT_CROSSBORDER"
                        | "LOCAL_US_WIRE"
                        | "LOCAL_STABLECOIN";
                    purposeCode: string;
                    referenceNumber?: string
                    | null;
                    valueDate?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accountId?: string | null;
                            amlDeclineReason?: string | null;
                            amlMonitoringEnabled?: boolean | null;
                            autoConfirm?: boolean | null;
                            cancellationRequestStatusCode?: string | null;
                            cancelReason?: string | null;
                            cancelRefuseReason?: string | null;
                            categoryPurposeCode?: string | null;
                            chargeBearer?: string | null;
                            contractSource?: {
                                contractNumber?: (...) | (...);
                                sourceName?: (...) | (...);
                                sourceRef?: (...) | (...);
                            };
                            counterpartyOriginalIban?: string
                            | null;
                            details?: string | null;
                            directionCode?: string | null;
                            endToEndId?: string | null;
                            errorCode?: string | null;
                            fees?:
                                | {
                                    actualFeeMoney?: ...;
                                    deferredFee?: ...;
                                    estimatedFee?: ...;
                                    feeMoney?: ...;
                                    feeTypeCode?: ...;
                                }[]
                                | null;
                            fileImportLineNumber?: number
                            | null;
                            fxPayment?: {
                                coverMoney?: (...) | (...);
                                exchangeRate?: (...) | (...) | (...);
                                fixedSide?: (...) | (...) | (...);
                                fxQuoteRequestId?: (...) | (...) | (...);
                                paymentMoney?: (...) | (...);
                                reservationMoney?: (...) | (...);
                                serviceProviderResult?: (...) | (...);
                            };
                            fxPaymentFlag?: boolean
                            | null;
                            insertedDateTime?: string | null;
                            labels?: string[] | null;
                            lastStatusRequestDate?: string | null;
                            money?: { amount?: (...) | (...); currencyCode: string };
                            paymentCancellationReasonCode?: string | null;
                            paymentId?: string | null;
                            paymentParties?:
                                | {
                                    accountNumber?: ...;
                                    accountNumberCountryCode?: ...;
                                    accountNumberSubtype?: ...;
                                    address?: ...;
                                    financialInstitutionId?: ...;
                                    givenName?: ...;
                                    name?: ...;
                                    partyIdentification?: ...;
                                    paymentPartyId?: ...;
                                    personTypeCode?: ...;
                                    roleCode?: ...;
                                    surname?: ...;
                                    tenantCode?: ...;
                                    typeCode?: ...;
                                }[]
                                | null;
                            paymentSchemeElements?: | {
                                fieldValue?: ...;
                                fieldValueCountryCode?: ...;
                                fieldValueSchemeTypeCode?: ...;
                                fieldValueTypeCode?: ...;
                                includeToMetaInfo?: ...;
                                tenantCode?: ...;
                            }[]
                            | null;
                            paymentServiceProviderCode?: string
                            | null;
                            paymentTypeCode?: string | null;
                            postingDate?: string | null;
                            preferredPaymentScheme?: string | null;
                            purposeCode?: string | null;
                            referenceNumber?: string | null;
                            residencyCountryCode?: string | null;
                            returnComment?: string | null;
                            returnReason?: string | null;
                            returnSettlementDate?: string | null;
                            returnStatusCode?: string | null;
                            selectedPaymentScheme?: string | null;
                            settlementDate?: string | null;
                            settlementErrorCode?: string | null;
                            settlementPaymentScheme?: string | null;
                            settlementStatusCode?: string | null;
                            source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                            statusCode?: string | null;
                            tenantCode?: string | null;
                            uetr?: string | null;
                            valueDate?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accountId?: string | null;
                          amlDeclineReason?: string | null;
                          amlMonitoringEnabled?: boolean | null;
                          autoConfirm?: boolean | null;
                          cancellationRequestStatusCode?: string | null;
                          cancelReason?: string | null;
                          cancelRefuseReason?: string | null;
                          categoryPurposeCode?: string | null;
                          chargeBearer?: string | null;
                          contractSource?: {
                              contractNumber?: (...) | (...);
                              sourceName?: (...) | (...);
                              sourceRef?: (...) | (...);
                          };
                          counterpartyOriginalIban?: string
                          | null;
                          details?: string | null;
                          directionCode?: string | null;
                          endToEndId?: string | null;
                          errorCode?: string | null;
                          fees?:
                              | {
                                  actualFeeMoney?: ...;
                                  deferredFee?: ...;
                                  estimatedFee?: ...;
                                  feeMoney?: ...;
                                  feeTypeCode?: ...;
                              }[]
                              | null;
                          fileImportLineNumber?: number
                          | null;
                          fxPayment?: {
                              coverMoney?: (...) | (...);
                              exchangeRate?: (...) | (...) | (...);
                              fixedSide?: (...) | (...) | (...);
                              fxQuoteRequestId?: (...) | (...) | (...);
                              paymentMoney?: (...) | (...);
                              reservationMoney?: (...) | (...);
                              serviceProviderResult?: (...) | (...);
                          };
                          fxPaymentFlag?: boolean
                          | null;
                          insertedDateTime?: string | null;
                          labels?: string[] | null;
                          lastStatusRequestDate?: string | null;
                          money?: { amount?: (...) | (...); currencyCode: string };
                          paymentCancellationReasonCode?: string | null;
                          paymentId?: string | null;
                          paymentParties?:
                              | {
                                  accountNumber?: ...;
                                  accountNumberCountryCode?: ...;
                                  accountNumberSubtype?: ...;
                                  address?: ...;
                                  financialInstitutionId?: ...;
                                  givenName?: ...;
                                  name?: ...;
                                  partyIdentification?: ...;
                                  paymentPartyId?: ...;
                                  personTypeCode?: ...;
                                  roleCode?: ...;
                                  surname?: ...;
                                  tenantCode?: ...;
                                  typeCode?: ...;
                              }[]
                              | null;
                          paymentSchemeElements?: | {
                              fieldValue?: ...;
                              fieldValueCountryCode?: ...;
                              fieldValueSchemeTypeCode?: ...;
                              fieldValueTypeCode?: ...;
                              includeToMetaInfo?: ...;
                              tenantCode?: ...;
                          }[]
                          | null;
                          paymentServiceProviderCode?: string
                          | null;
                          paymentTypeCode?: string | null;
                          postingDate?: string | null;
                          preferredPaymentScheme?: string | null;
                          purposeCode?: string | null;
                          referenceNumber?: string | null;
                          residencyCountryCode?: string | null;
                          returnComment?: string | null;
                          returnReason?: string | null;
                          returnSettlementDate?: string | null;
                          returnStatusCode?: string | null;
                          selectedPaymentScheme?: string | null;
                          settlementDate?: string | null;
                          settlementErrorCode?: string | null;
                          settlementPaymentScheme?: string | null;
                          settlementStatusCode?: string | null;
                          source?: { sourceName?: (...) | (...); sourceRef?: (...) | (...) };
                          statusCode?: string | null;
                          tenantCode?: string | null;
                          uetr?: string | null;
                          valueDate?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/persons/{personId}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                activityCode?: string | null;
                                birthDate?: string | null;
                                buildingTypeCode?: string | null;
                                businessAreaCodes?: string[] | null;
                                businessModelDescription?: string | null;
                                counterpartySectorCode?: string | null;
                                countryOfBirth?: string | null;
                                creationDate?: string | null;
                                customerTypeCode?: string | null;
                                deathDate?: string | null;
                                dependantPersons?: number | null;
                                educationCode?: string | null;
                                email?: string | null;
                                employmentTimeCode?: string | null;
                                fixedEmploymentLength?: number | null;
                                forgotten?: boolean | null;
                                fullName?: string | null;
                                givenName?: string | null;
                                housingTypeCode?: string | null;
                                idCountryCode?: string | null;
                                idNumber?: string | null;
                                inactivationDate?: string | null;
                                insertedDTime?: string | null;
                                intraOrgCode?: string | null;
                                language?: string | null;
                                legalForm?: string | null;
                                liquidationDate?: string | null;
                                mainPersonId?: string | null;
                                maritalStatusCode?: string | null;
                                middleName?: string | null;
                                name?: string | null;
                                nationality?: string | null;
                                pep?: boolean | null;
                                pepExplanation?: string | null;
                                personGroupCodes?: string[] | null;
                                personId?: string | null;
                                personTypeCode?: string | null;
                                phoneCountryCode?: string | null;
                                phoneNumber?: string | null;
                                placeOfBirth?: string | null;
                                registrationDate?: string | null;
                                residencyCountryCode?: string | null;
                                sex?: string | null;
                                source?: {
                                    sourceLink?: (...) | (...) | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                statusCode?: string
                                | null;
                                statusCodeReason?: string | null;
                                surname?: string | null;
                                taxResidencyCountry?: string | null;
                                tenantCode?: string | null;
                                tradingName?: string | null;
                                usResident?: boolean | null;
                                webAddress?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              activityCode?: string | null;
                              birthDate?: string | null;
                              buildingTypeCode?: string | null;
                              businessAreaCodes?: string[] | null;
                              businessModelDescription?: string | null;
                              counterpartySectorCode?: string | null;
                              countryOfBirth?: string | null;
                              creationDate?: string | null;
                              customerTypeCode?: string | null;
                              deathDate?: string | null;
                              dependantPersons?: number | null;
                              educationCode?: string | null;
                              email?: string | null;
                              employmentTimeCode?: string | null;
                              fixedEmploymentLength?: number | null;
                              forgotten?: boolean | null;
                              fullName?: string | null;
                              givenName?: string | null;
                              housingTypeCode?: string | null;
                              idCountryCode?: string | null;
                              idNumber?: string | null;
                              inactivationDate?: string | null;
                              insertedDTime?: string | null;
                              intraOrgCode?: string | null;
                              language?: string | null;
                              legalForm?: string | null;
                              liquidationDate?: string | null;
                              mainPersonId?: string | null;
                              maritalStatusCode?: string | null;
                              middleName?: string | null;
                              name?: string | null;
                              nationality?: string | null;
                              pep?: boolean | null;
                              pepExplanation?: string | null;
                              personGroupCodes?: string[] | null;
                              personId?: string | null;
                              personTypeCode?: string | null;
                              phoneCountryCode?: string | null;
                              phoneNumber?: string | null;
                              placeOfBirth?: string | null;
                              registrationDate?: string | null;
                              residencyCountryCode?: string | null;
                              sex?: string | null;
                              source?: {
                                  sourceLink?: (...) | (...) | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              statusCode?: string
                              | null;
                              statusCodeReason?: string | null;
                              surname?: string | null;
                              taxResidencyCountry?: string | null;
                              tenantCode?: string | null;
                              tradingName?: string | null;
                              usResident?: boolean | null;
                              webAddress?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find person by ID

      Find person by ID

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            activityCode?: string | null;
                            birthDate?: string | null;
                            buildingTypeCode?: string | null;
                            businessAreaCodes?: string[] | null;
                            businessModelDescription?: string | null;
                            counterpartySectorCode?: string | null;
                            countryOfBirth?: string | null;
                            creationDate?: string | null;
                            customerTypeCode?: string | null;
                            deathDate?: string | null;
                            dependantPersons?: number | null;
                            educationCode?: string | null;
                            email?: string | null;
                            employmentTimeCode?: string | null;
                            fixedEmploymentLength?: number | null;
                            forgotten?: boolean | null;
                            fullName?: string | null;
                            givenName?: string | null;
                            housingTypeCode?: string | null;
                            idCountryCode?: string | null;
                            idNumber?: string | null;
                            inactivationDate?: string | null;
                            insertedDTime?: string | null;
                            intraOrgCode?: string | null;
                            language?: string | null;
                            legalForm?: string | null;
                            liquidationDate?: string | null;
                            mainPersonId?: string | null;
                            maritalStatusCode?: string | null;
                            middleName?: string | null;
                            name?: string | null;
                            nationality?: string | null;
                            pep?: boolean | null;
                            pepExplanation?: string | null;
                            personGroupCodes?: string[] | null;
                            personId?: string | null;
                            personTypeCode?: string | null;
                            phoneCountryCode?: string | null;
                            phoneNumber?: string | null;
                            placeOfBirth?: string | null;
                            registrationDate?: string | null;
                            residencyCountryCode?: string | null;
                            sex?: string | null;
                            source?: {
                                sourceLink?: (...) | (...) | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCode?: string
                            | null;
                            statusCodeReason?: string | null;
                            surname?: string | null;
                            taxResidencyCountry?: string | null;
                            tenantCode?: string | null;
                            tradingName?: string | null;
                            usResident?: boolean | null;
                            webAddress?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          activityCode?: string | null;
                          birthDate?: string | null;
                          buildingTypeCode?: string | null;
                          businessAreaCodes?: string[] | null;
                          businessModelDescription?: string | null;
                          counterpartySectorCode?: string | null;
                          countryOfBirth?: string | null;
                          creationDate?: string | null;
                          customerTypeCode?: string | null;
                          deathDate?: string | null;
                          dependantPersons?: number | null;
                          educationCode?: string | null;
                          email?: string | null;
                          employmentTimeCode?: string | null;
                          fixedEmploymentLength?: number | null;
                          forgotten?: boolean | null;
                          fullName?: string | null;
                          givenName?: string | null;
                          housingTypeCode?: string | null;
                          idCountryCode?: string | null;
                          idNumber?: string | null;
                          inactivationDate?: string | null;
                          insertedDTime?: string | null;
                          intraOrgCode?: string | null;
                          language?: string | null;
                          legalForm?: string | null;
                          liquidationDate?: string | null;
                          mainPersonId?: string | null;
                          maritalStatusCode?: string | null;
                          middleName?: string | null;
                          name?: string | null;
                          nationality?: string | null;
                          pep?: boolean | null;
                          pepExplanation?: string | null;
                          personGroupCodes?: string[] | null;
                          personId?: string | null;
                          personTypeCode?: string | null;
                          phoneCountryCode?: string | null;
                          phoneNumber?: string | null;
                          placeOfBirth?: string | null;
                          registrationDate?: string | null;
                          residencyCountryCode?: string | null;
                          sex?: string | null;
                          source?: {
                              sourceLink?: (...) | (...) | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          statusCode?: string
                          | null;
                          statusCodeReason?: string | null;
                          surname?: string | null;
                          taxResidencyCountry?: string | null;
                          tenantCode?: string | null;
                          tradingName?: string | null;
                          usResident?: boolean | null;
                          webAddress?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v3/transactions/{transactionId}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { transactionId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accountId?: string
                                | null;
                                accountTransactionId?: string | null;
                                amount?: number | null;
                                contractSource?: {
                                    contractNumber: string;
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                counterparty?: {
                                    accountNumber?: (...)
                                    | (...);
                                    accountNumberCountryCode?: (...) | (...) | (...);
                                    accountNumberSubtype?: (...) | (...) | (...);
                                    financialInstitutionId?: (...) | (...);
                                    name?: (...) | (...) | (...);
                                };
                                createdDTime?: string
                                | null;
                                currencyCode?: string | null;
                                customBookingAllowed?: boolean | null;
                                details?: string | null;
                                directionCode?: "IN" | "OUT";
                                domainCode?: string | null;
                                endToEndId?: string | null;
                                familyCode?: string | null;
                                filingCode?: string | null;
                                groupId?: string | null;
                                initialBalanceAmount?: number | null;
                                labels?: string[] | null;
                                merchantInfo?: string | null;
                                metaInfo?: string | null;
                                paymentServiceProviderCode?: string | null;
                                postingDate?: string | null;
                                referenceNumber?: string | null;
                                reservationId?: string | null;
                                reversal?: boolean | null;
                                reversalTransactionId?: string | null;
                                reversed?: boolean | null;
                                reversedByTransactionId?: string | null;
                                source?: {
                                    sourceLink?: (...) | (...) | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                subFamilyCode?: string
                                | null;
                                tenantCode?: string | null;
                                transactionDTime?: string | null;
                                transactionSubtypeCode?: string | null;
                                transactionTypeCode?: string | null;
                                uniqueIdentifier?: string | null;
                                usage?: { limitCode?: (...) | (...) | (...); userPersonId: string };
                                valueDate?: string | null;
                                virtualAccountId?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { transactionId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accountId?: string
                              | null;
                              accountTransactionId?: string | null;
                              amount?: number | null;
                              contractSource?: {
                                  contractNumber: string;
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              counterparty?: {
                                  accountNumber?: (...)
                                  | (...);
                                  accountNumberCountryCode?: (...) | (...) | (...);
                                  accountNumberSubtype?: (...) | (...) | (...);
                                  financialInstitutionId?: (...) | (...);
                                  name?: (...) | (...) | (...);
                              };
                              createdDTime?: string
                              | null;
                              currencyCode?: string | null;
                              customBookingAllowed?: boolean | null;
                              details?: string | null;
                              directionCode?: "IN" | "OUT";
                              domainCode?: string | null;
                              endToEndId?: string | null;
                              familyCode?: string | null;
                              filingCode?: string | null;
                              groupId?: string | null;
                              initialBalanceAmount?: number | null;
                              labels?: string[] | null;
                              merchantInfo?: string | null;
                              metaInfo?: string | null;
                              paymentServiceProviderCode?: string | null;
                              postingDate?: string | null;
                              referenceNumber?: string | null;
                              reservationId?: string | null;
                              reversal?: boolean | null;
                              reversalTransactionId?: string | null;
                              reversed?: boolean | null;
                              reversedByTransactionId?: string | null;
                              source?: {
                                  sourceLink?: (...) | (...) | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              subFamilyCode?: string
                              | null;
                              tenantCode?: string | null;
                              transactionDTime?: string | null;
                              transactionSubtypeCode?: string | null;
                              transactionTypeCode?: string | null;
                              uniqueIdentifier?: string | null;
                              usage?: { limitCode?: (...) | (...) | (...); userPersonId: string };
                              valueDate?: string | null;
                              virtualAccountId?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find master account transaction

      Finds master account transactions by transaction ID

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { transactionId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { transactionId: string }
          • transactionId: string
            ID-1001
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accountId?: string | null;
                            accountTransactionId?: string | null;
                            amount?: number | null;
                            contractSource?: {
                                contractNumber: string;
                                sourceName: string;
                                sourceRef: string;
                            };
                            counterparty?: {
                                accountNumber?: (...)
                                | (...);
                                accountNumberCountryCode?: (...) | (...) | (...);
                                accountNumberSubtype?: (...) | (...) | (...);
                                financialInstitutionId?: (...) | (...);
                                name?: (...) | (...) | (...);
                            };
                            createdDTime?: string
                            | null;
                            currencyCode?: string | null;
                            customBookingAllowed?: boolean | null;
                            details?: string | null;
                            directionCode?: "IN" | "OUT";
                            domainCode?: string | null;
                            endToEndId?: string | null;
                            familyCode?: string | null;
                            filingCode?: string | null;
                            groupId?: string | null;
                            initialBalanceAmount?: number | null;
                            labels?: string[] | null;
                            merchantInfo?: string | null;
                            metaInfo?: string | null;
                            paymentServiceProviderCode?: string | null;
                            postingDate?: string | null;
                            referenceNumber?: string | null;
                            reservationId?: string | null;
                            reversal?: boolean | null;
                            reversalTransactionId?: string | null;
                            reversed?: boolean | null;
                            reversedByTransactionId?: string | null;
                            source?: {
                                sourceLink?: (...) | (...) | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            subFamilyCode?: string
                            | null;
                            tenantCode?: string | null;
                            transactionDTime?: string | null;
                            transactionSubtypeCode?: string | null;
                            transactionTypeCode?: string | null;
                            uniqueIdentifier?: string | null;
                            usage?: { limitCode?: (...) | (...) | (...); userPersonId: string };
                            valueDate?: string | null;
                            virtualAccountId?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accountId?: string | null;
                          accountTransactionId?: string | null;
                          amount?: number | null;
                          contractSource?: {
                              contractNumber: string;
                              sourceName: string;
                              sourceRef: string;
                          };
                          counterparty?: {
                              accountNumber?: (...)
                              | (...);
                              accountNumberCountryCode?: (...) | (...) | (...);
                              accountNumberSubtype?: (...) | (...) | (...);
                              financialInstitutionId?: (...) | (...);
                              name?: (...) | (...) | (...);
                          };
                          createdDTime?: string
                          | null;
                          currencyCode?: string | null;
                          customBookingAllowed?: boolean | null;
                          details?: string | null;
                          directionCode?: "IN" | "OUT";
                          domainCode?: string | null;
                          endToEndId?: string | null;
                          familyCode?: string | null;
                          filingCode?: string | null;
                          groupId?: string | null;
                          initialBalanceAmount?: number | null;
                          labels?: string[] | null;
                          merchantInfo?: string | null;
                          metaInfo?: string | null;
                          paymentServiceProviderCode?: string | null;
                          postingDate?: string | null;
                          referenceNumber?: string | null;
                          reservationId?: string | null;
                          reversal?: boolean | null;
                          reversalTransactionId?: string | null;
                          reversed?: boolean | null;
                          reversedByTransactionId?: string | null;
                          source?: {
                              sourceLink?: (...) | (...) | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          subFamilyCode?: string
                          | null;
                          tenantCode?: string | null;
                          transactionDTime?: string | null;
                          transactionSubtypeCode?: string | null;
                          transactionTypeCode?: string | null;
                          uniqueIdentifier?: string | null;
                          usage?: { limitCode?: (...) | (...) | (...); userPersonId: string };
                          valueDate?: string | null;
                          virtualAccountId?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v4/accounts/{accountId}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { accountId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                accountClassCode?: string | null;
                                accountId?: string | null;
                                accountName?: string | null;
                                accountNumbers?:
                                    | {
                                        accountId?: ...;
                                        accountNumber: ...;
                                        accountNumberId?: ...;
                                        accountNumberSubtype?: ...;
                                        countryCode?: ...;
                                        defaultCurrencyCode?: ...;
                                        externalSyncEnabled?: ...;
                                        financialInstitutionId?: ...;
                                        statusCode?: ...;
                                        tenantCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                accountTypeCode?: | "CURRENCY"
                                | "INTERNAL"
                                | "SAVING"
                                | "SHADOW"
                                | "VIRTUAL";
                                accountTypeSetupCode?: string
                                | null;
                                activationDate?: string | null;
                                balances?:
                                    | {
                                        accountId: ...;
                                        availableBalanceAmount?: ...;
                                        availableBalanceInDefaultCcy?: ...;
                                        balanceAmount?: ...;
                                        balanceId: ...;
                                        currencyCode: ...;
                                        defaultCurrencyCode?: ...;
                                        negativeBalanceStartDate?: ...;
                                        overdraftLimitAmount?: ...;
                                        reservedAmount?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                bic?: string
                                | null;
                                counterpartySectorCode?: string | null;
                                customerGroupCode?: string | null;
                                defaultCurrencyCode?: string | null;
                                iban?: string | null;
                                interestMethodAssignmentCode?: string | null;
                                intraOrgCode?: string | null;
                                jurisdictionCountryCode?: string | null;
                                masterAccountId?: string | null;
                                personId?: string | null;
                                personName?: string | null;
                                personTypeCode?: string | null;
                                productCode?: string | null;
                                residencyCode?: string | null;
                                serviceProviderCode?: string | null;
                                source?: { sourceName: string; sourceRef: string };
                                statusCode?:
                                    | "ACTIVE"
                                    | "INACTIVE"
                                    | "CLOSED"
                                    | "CREATED"
                                    | "BLOCKED"
                                    | "WAITING_FOR_CLOSURE_DECISION";
                                statusReasonCode?: string
                                | null;
                                taxResidencyCountryCode?: string | null;
                                tenantCode?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { accountId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              accountClassCode?: string | null;
                              accountId?: string | null;
                              accountName?: string | null;
                              accountNumbers?:
                                  | {
                                      accountId?: ...;
                                      accountNumber: ...;
                                      accountNumberId?: ...;
                                      accountNumberSubtype?: ...;
                                      countryCode?: ...;
                                      defaultCurrencyCode?: ...;
                                      externalSyncEnabled?: ...;
                                      financialInstitutionId?: ...;
                                      statusCode?: ...;
                                      tenantCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              accountTypeCode?: | "CURRENCY"
                              | "INTERNAL"
                              | "SAVING"
                              | "SHADOW"
                              | "VIRTUAL";
                              accountTypeSetupCode?: string
                              | null;
                              activationDate?: string | null;
                              balances?:
                                  | {
                                      accountId: ...;
                                      availableBalanceAmount?: ...;
                                      availableBalanceInDefaultCcy?: ...;
                                      balanceAmount?: ...;
                                      balanceId: ...;
                                      currencyCode: ...;
                                      defaultCurrencyCode?: ...;
                                      negativeBalanceStartDate?: ...;
                                      overdraftLimitAmount?: ...;
                                      reservedAmount?: ...;
                                      tenantCode?: ...;
                                  }[]
                                  | null;
                              bic?: string
                              | null;
                              counterpartySectorCode?: string | null;
                              customerGroupCode?: string | null;
                              defaultCurrencyCode?: string | null;
                              iban?: string | null;
                              interestMethodAssignmentCode?: string | null;
                              intraOrgCode?: string | null;
                              jurisdictionCountryCode?: string | null;
                              masterAccountId?: string | null;
                              personId?: string | null;
                              personName?: string | null;
                              personTypeCode?: string | null;
                              productCode?: string | null;
                              residencyCode?: string | null;
                              serviceProviderCode?: string | null;
                              source?: { sourceName: string; sourceRef: string };
                              statusCode?:
                                  | "ACTIVE"
                                  | "INACTIVE"
                                  | "CLOSED"
                                  | "CREATED"
                                  | "BLOCKED"
                                  | "WAITING_FOR_CLOSURE_DECISION";
                              statusReasonCode?: string
                              | null;
                              taxResidencyCountryCode?: string | null;
                              tenantCode?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find account by ID

      Returns account data by account ID

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { accountId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            accountClassCode?: string | null;
                            accountId?: string | null;
                            accountName?: string | null;
                            accountNumbers?:
                                | {
                                    accountId?: ...;
                                    accountNumber: ...;
                                    accountNumberId?: ...;
                                    accountNumberSubtype?: ...;
                                    countryCode?: ...;
                                    defaultCurrencyCode?: ...;
                                    externalSyncEnabled?: ...;
                                    financialInstitutionId?: ...;
                                    statusCode?: ...;
                                    tenantCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            accountTypeCode?: | "CURRENCY"
                            | "INTERNAL"
                            | "SAVING"
                            | "SHADOW"
                            | "VIRTUAL";
                            accountTypeSetupCode?: string
                            | null;
                            activationDate?: string | null;
                            balances?:
                                | {
                                    accountId: ...;
                                    availableBalanceAmount?: ...;
                                    availableBalanceInDefaultCcy?: ...;
                                    balanceAmount?: ...;
                                    balanceId: ...;
                                    currencyCode: ...;
                                    defaultCurrencyCode?: ...;
                                    negativeBalanceStartDate?: ...;
                                    overdraftLimitAmount?: ...;
                                    reservedAmount?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                            bic?: string
                            | null;
                            counterpartySectorCode?: string | null;
                            customerGroupCode?: string | null;
                            defaultCurrencyCode?: string | null;
                            iban?: string | null;
                            interestMethodAssignmentCode?: string | null;
                            intraOrgCode?: string | null;
                            jurisdictionCountryCode?: string | null;
                            masterAccountId?: string | null;
                            personId?: string | null;
                            personName?: string | null;
                            personTypeCode?: string | null;
                            productCode?: string | null;
                            residencyCode?: string | null;
                            serviceProviderCode?: string | null;
                            source?: { sourceName: string; sourceRef: string };
                            statusCode?:
                                | "ACTIVE"
                                | "INACTIVE"
                                | "CLOSED"
                                | "CREATED"
                                | "BLOCKED"
                                | "WAITING_FOR_CLOSURE_DECISION";
                            statusReasonCode?: string
                            | null;
                            taxResidencyCountryCode?: string | null;
                            tenantCode?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          accountClassCode?: string | null;
                          accountId?: string | null;
                          accountName?: string | null;
                          accountNumbers?:
                              | {
                                  accountId?: ...;
                                  accountNumber: ...;
                                  accountNumberId?: ...;
                                  accountNumberSubtype?: ...;
                                  countryCode?: ...;
                                  defaultCurrencyCode?: ...;
                                  externalSyncEnabled?: ...;
                                  financialInstitutionId?: ...;
                                  statusCode?: ...;
                                  tenantCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          accountTypeCode?: | "CURRENCY"
                          | "INTERNAL"
                          | "SAVING"
                          | "SHADOW"
                          | "VIRTUAL";
                          accountTypeSetupCode?: string
                          | null;
                          activationDate?: string | null;
                          balances?:
                              | {
                                  accountId: ...;
                                  availableBalanceAmount?: ...;
                                  availableBalanceInDefaultCcy?: ...;
                                  balanceAmount?: ...;
                                  balanceId: ...;
                                  currencyCode: ...;
                                  defaultCurrencyCode?: ...;
                                  negativeBalanceStartDate?: ...;
                                  overdraftLimitAmount?: ...;
                                  reservedAmount?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                          bic?: string
                          | null;
                          counterpartySectorCode?: string | null;
                          customerGroupCode?: string | null;
                          defaultCurrencyCode?: string | null;
                          iban?: string | null;
                          interestMethodAssignmentCode?: string | null;
                          intraOrgCode?: string | null;
                          jurisdictionCountryCode?: string | null;
                          masterAccountId?: string | null;
                          personId?: string | null;
                          personName?: string | null;
                          personTypeCode?: string | null;
                          productCode?: string | null;
                          residencyCode?: string | null;
                          serviceProviderCode?: string | null;
                          source?: { sourceName: string; sourceRef: string };
                          statusCode?:
                              | "ACTIVE"
                              | "INACTIVE"
                              | "CLOSED"
                              | "CREATED"
                              | "BLOCKED"
                              | "WAITING_FOR_CLOSURE_DECISION";
                          statusReasonCode?: string
                          | null;
                          taxResidencyCountryCode?: string | null;
                          tenantCode?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v4/accounts/{accountId}/transactions/search": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { accountId: string };
                query: {
                    amountFrom?: number;
                    amountTo?: number;
                    contractNumber?: string;
                    currencyCode?: string;
                    dateFrom: string;
                    dateTo: string;
                    dateType: "VALUE_DATE" | "POSTING_DATE";
                    directionCode?: string;
                    includeAccessRestricted?: boolean;
                    pageNumber?: number;
                    pageSize?: number;
                    referenceNumber?: string;
                    sourceName?: string;
                    sourceRef?: string;
                    transactionGroupCode?: string;
                    transactionSubtype?: string;
                    transactionType?: string;
                    uniqueIdentifier?: string;
                    virtualAccountId?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                total?: number | null;
                                values?:
                                    | {
                                        accountId?: ...;
                                        accountTransactionId?: ...;
                                        amount?: ...;
                                        contractSource?: ...;
                                        counterparty?: ...;
                                        createdDTime?: ...;
                                        currencyCode?: ...;
                                        details?: ...;
                                        directionCode?: ...;
                                        endToEndId?: ...;
                                        filingCode?: ...;
                                        groupId?: ...;
                                        initialBalanceAmount?: ...;
                                        labels?: ...;
                                        merchantInfo?: ...;
                                        metaInfo?: ...;
                                        paymentServiceProviderCode?: ...;
                                        postingDate?: ...;
                                        referenceNumber?: ...;
                                        reservationId?: ...;
                                        reversed?: ...;
                                        source?: ...;
                                        tenantCode?: ...;
                                        transactionDTime?: ...;
                                        transactionSubtypeCode?: ...;
                                        transactionTypeCode?: ...;
                                        uniqueIdentifier?: ...;
                                        usage?: ...;
                                        valueDate?: ...;
                                        virtualAccountId?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { accountId: string };
              query: {
                  amountFrom?: number;
                  amountTo?: number;
                  contractNumber?: string;
                  currencyCode?: string;
                  dateFrom: string;
                  dateTo: string;
                  dateType: "VALUE_DATE" | "POSTING_DATE";
                  directionCode?: string;
                  includeAccessRestricted?: boolean;
                  pageNumber?: number;
                  pageSize?: number;
                  referenceNumber?: string;
                  sourceName?: string;
                  sourceRef?: string;
                  transactionGroupCode?: string;
                  transactionSubtype?: string;
                  transactionType?: string;
                  uniqueIdentifier?: string;
                  virtualAccountId?: string;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              total?: number | null;
                              values?:
                                  | {
                                      accountId?: ...;
                                      accountTransactionId?: ...;
                                      amount?: ...;
                                      contractSource?: ...;
                                      counterparty?: ...;
                                      createdDTime?: ...;
                                      currencyCode?: ...;
                                      details?: ...;
                                      directionCode?: ...;
                                      endToEndId?: ...;
                                      filingCode?: ...;
                                      groupId?: ...;
                                      initialBalanceAmount?: ...;
                                      labels?: ...;
                                      merchantInfo?: ...;
                                      metaInfo?: ...;
                                      paymentServiceProviderCode?: ...;
                                      postingDate?: ...;
                                      referenceNumber?: ...;
                                      reservationId?: ...;
                                      reversed?: ...;
                                      source?: ...;
                                      tenantCode?: ...;
                                      transactionDTime?: ...;
                                      transactionSubtypeCode?: ...;
                                      transactionTypeCode?: ...;
                                      uniqueIdentifier?: ...;
                                      usage?: ...;
                                      valueDate?: ...;
                                      virtualAccountId?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Search master account transactions

      Finds master account transactions by multiple criteria

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { accountId: string };
            query: {
                amountFrom?: number;
                amountTo?: number;
                contractNumber?: string;
                currencyCode?: string;
                dateFrom: string;
                dateTo: string;
                dateType: "VALUE_DATE" | "POSTING_DATE";
                directionCode?: string;
                includeAccessRestricted?: boolean;
                pageNumber?: number;
                pageSize?: number;
                referenceNumber?: string;
                sourceName?: string;
                sourceRef?: string;
                transactionGroupCode?: string;
                transactionSubtype?: string;
                transactionType?: string;
                uniqueIdentifier?: string;
                virtualAccountId?: string;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
          • accountId: string
            ID-1020
            
        • query: {
              amountFrom?: number;
              amountTo?: number;
              contractNumber?: string;
              currencyCode?: string;
              dateFrom: string;
              dateTo: string;
              dateType: "VALUE_DATE" | "POSTING_DATE";
              directionCode?: string;
              includeAccessRestricted?: boolean;
              pageNumber?: number;
              pageSize?: number;
              referenceNumber?: string;
              sourceName?: string;
              sourceRef?: string;
              transactionGroupCode?: string;
              transactionSubtype?: string;
              transactionType?: string;
              uniqueIdentifier?: string;
              virtualAccountId?: string;
          }
          • OptionalamountFrom?: number
            10.1
            
          • OptionalamountTo?: number
            90.3
            
          • OptionalcontractNumber?: string
            KD6-3.7
            
          • OptionalcurrencyCode?: string
            USD
            
          • dateFrom: string

            Format YYYY-MM-DD.

            2022-06-15
            
          • dateTo: string

            Format YYYY-MM-DD.

            2022-06-15
            
          • dateType: "VALUE_DATE" | "POSTING_DATE"
            VALUE_DATE
            
          • OptionaldirectionCode?: string
            IN
            
          • OptionalincludeAccessRestricted?: boolean

            If false then transactions under restricted accounts are not returned. If true and user has privilege READ_RESTRICTED_DATA then the restricted data is also returned.

          • OptionalpageNumber?: number

            Format - int32. Page number

            1
            
          • OptionalpageSize?: number

            Format - int32. Page size

            30
            
          • OptionalreferenceNumber?: string
            12345678
            
          • OptionalsourceName?: string
            CURRENCY_EXCHANGE
            
          • OptionalsourceRef?: string
            ID-1200
            
          • OptionaltransactionGroupCode?: string
          • OptionaltransactionSubtype?: string
            ST_DEPOSIT
            
          • OptionaltransactionType?: string
            ACC2EXTERNAL_PAY
            
          • OptionaluniqueIdentifier?: string
          • OptionalvirtualAccountId?: string
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            total?: number | null;
                            values?:
                                | {
                                    accountId?: ...;
                                    accountTransactionId?: ...;
                                    amount?: ...;
                                    contractSource?: ...;
                                    counterparty?: ...;
                                    createdDTime?: ...;
                                    currencyCode?: ...;
                                    details?: ...;
                                    directionCode?: ...;
                                    endToEndId?: ...;
                                    filingCode?: ...;
                                    groupId?: ...;
                                    initialBalanceAmount?: ...;
                                    labels?: ...;
                                    merchantInfo?: ...;
                                    metaInfo?: ...;
                                    paymentServiceProviderCode?: ...;
                                    postingDate?: ...;
                                    referenceNumber?: ...;
                                    reservationId?: ...;
                                    reversed?: ...;
                                    source?: ...;
                                    tenantCode?: ...;
                                    transactionDTime?: ...;
                                    transactionSubtypeCode?: ...;
                                    transactionTypeCode?: ...;
                                    uniqueIdentifier?: ...;
                                    usage?: ...;
                                    valueDate?: ...;
                                    virtualAccountId?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          total?: number | null;
                          values?:
                              | {
                                  accountId?: ...;
                                  accountTransactionId?: ...;
                                  amount?: ...;
                                  contractSource?: ...;
                                  counterparty?: ...;
                                  createdDTime?: ...;
                                  currencyCode?: ...;
                                  details?: ...;
                                  directionCode?: ...;
                                  endToEndId?: ...;
                                  filingCode?: ...;
                                  groupId?: ...;
                                  initialBalanceAmount?: ...;
                                  labels?: ...;
                                  merchantInfo?: ...;
                                  metaInfo?: ...;
                                  paymentServiceProviderCode?: ...;
                                  postingDate?: ...;
                                  referenceNumber?: ...;
                                  reservationId?: ...;
                                  reversed?: ...;
                                  source?: ...;
                                  tenantCode?: ...;
                                  transactionDTime?: ...;
                                  transactionSubtypeCode?: ...;
                                  transactionTypeCode?: ...;
                                  uniqueIdentifier?: ...;
                                  usage?: ...;
                                  valueDate?: ...;
                                  virtualAccountId?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v4/persons/{personId}/accounts": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        accountClassCode: | "PERSONAL_DDA"
                        | "BUSINESS_DDA"
                        | "CORPORATE_DDA"
                        | "FINANCIALINSTITUTION_OPS_DDA"
                        | "FI_CONCENTRATION_DDA";
                        accountName?: string
                        | null;
                        currencyCode: "USD";
                        masterAccountId: string;
                    };
                    "application/json": {
                        accountClassCode: | "PERSONAL_DDA"
                        | "BUSINESS_DDA"
                        | "CORPORATE_DDA"
                        | "FINANCIALINSTITUTION_OPS_DDA"
                        | "FI_CONCENTRATION_DDA";
                        accountName?: string
                        | null;
                        currencyCode: "USD";
                        masterAccountId: string;
                    };
                    "text/json": {
                        accountClassCode: | "PERSONAL_DDA"
                        | "BUSINESS_DDA"
                        | "CORPORATE_DDA"
                        | "FINANCIALINSTITUTION_OPS_DDA"
                        | "FI_CONCENTRATION_DDA";
                        accountName?: string
                        | null;
                        currencyCode: "USD";
                        masterAccountId: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                accountClassCode?: string | null;
                                accountId?: string | null;
                                accountName?: string | null;
                                accountNumbers?:
                                    | {
                                        accountId?: ...;
                                        accountNumber: ...;
                                        accountNumberId?: ...;
                                        accountNumberSubtype?: ...;
                                        countryCode?: ...;
                                        defaultCurrencyCode?: ...;
                                        externalSyncEnabled?: ...;
                                        financialInstitutionId?: ...;
                                        statusCode?: ...;
                                        tenantCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                accountTypeCode?: | "CURRENCY"
                                | "INTERNAL"
                                | "SAVING"
                                | "SHADOW"
                                | "VIRTUAL";
                                accountTypeSetupCode?: string
                                | null;
                                activationDate?: string | null;
                                balances?:
                                    | {
                                        accountId: ...;
                                        availableBalanceAmount?: ...;
                                        availableBalanceInDefaultCcy?: ...;
                                        balanceAmount?: ...;
                                        balanceId: ...;
                                        currencyCode: ...;
                                        defaultCurrencyCode?: ...;
                                        negativeBalanceStartDate?: ...;
                                        overdraftLimitAmount?: ...;
                                        reservedAmount?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                                bic?: string
                                | null;
                                counterpartySectorCode?: string | null;
                                customerGroupCode?: string | null;
                                defaultCurrencyCode?: string | null;
                                iban?: string | null;
                                interestMethodAssignmentCode?: string | null;
                                intraOrgCode?: string | null;
                                jurisdictionCountryCode?: string | null;
                                masterAccountId?: string | null;
                                personId?: string | null;
                                personName?: string | null;
                                personTypeCode?: string | null;
                                productCode?: string | null;
                                residencyCode?: string | null;
                                serviceProviderCode?: string | null;
                                source?: { sourceName: string; sourceRef: string };
                                statusCode?:
                                    | "ACTIVE"
                                    | "INACTIVE"
                                    | "CLOSED"
                                    | "CREATED"
                                    | "BLOCKED"
                                    | "WAITING_FOR_CLOSURE_DECISION";
                                statusReasonCode?: string
                                | null;
                                taxResidencyCountryCode?: string | null;
                                tenantCode?: string | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      accountClassCode: | "PERSONAL_DDA"
                      | "BUSINESS_DDA"
                      | "CORPORATE_DDA"
                      | "FINANCIALINSTITUTION_OPS_DDA"
                      | "FI_CONCENTRATION_DDA";
                      accountName?: string
                      | null;
                      currencyCode: "USD";
                      masterAccountId: string;
                  };
                  "application/json": {
                      accountClassCode: | "PERSONAL_DDA"
                      | "BUSINESS_DDA"
                      | "CORPORATE_DDA"
                      | "FINANCIALINSTITUTION_OPS_DDA"
                      | "FI_CONCENTRATION_DDA";
                      accountName?: string
                      | null;
                      currencyCode: "USD";
                      masterAccountId: string;
                  };
                  "text/json": {
                      accountClassCode: | "PERSONAL_DDA"
                      | "BUSINESS_DDA"
                      | "CORPORATE_DDA"
                      | "FINANCIALINSTITUTION_OPS_DDA"
                      | "FI_CONCENTRATION_DDA";
                      accountName?: string
                      | null;
                      currencyCode: "USD";
                      masterAccountId: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              accountClassCode?: string | null;
                              accountId?: string | null;
                              accountName?: string | null;
                              accountNumbers?:
                                  | {
                                      accountId?: ...;
                                      accountNumber: ...;
                                      accountNumberId?: ...;
                                      accountNumberSubtype?: ...;
                                      countryCode?: ...;
                                      defaultCurrencyCode?: ...;
                                      externalSyncEnabled?: ...;
                                      financialInstitutionId?: ...;
                                      statusCode?: ...;
                                      tenantCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              accountTypeCode?: | "CURRENCY"
                              | "INTERNAL"
                              | "SAVING"
                              | "SHADOW"
                              | "VIRTUAL";
                              accountTypeSetupCode?: string
                              | null;
                              activationDate?: string | null;
                              balances?:
                                  | {
                                      accountId: ...;
                                      availableBalanceAmount?: ...;
                                      availableBalanceInDefaultCcy?: ...;
                                      balanceAmount?: ...;
                                      balanceId: ...;
                                      currencyCode: ...;
                                      defaultCurrencyCode?: ...;
                                      negativeBalanceStartDate?: ...;
                                      overdraftLimitAmount?: ...;
                                      reservedAmount?: ...;
                                      tenantCode?: ...;
                                  }[]
                                  | null;
                              bic?: string
                              | null;
                              counterpartySectorCode?: string | null;
                              customerGroupCode?: string | null;
                              defaultCurrencyCode?: string | null;
                              iban?: string | null;
                              interestMethodAssignmentCode?: string | null;
                              intraOrgCode?: string | null;
                              jurisdictionCountryCode?: string | null;
                              masterAccountId?: string | null;
                              personId?: string | null;
                              personName?: string | null;
                              personTypeCode?: string | null;
                              productCode?: string | null;
                              residencyCode?: string | null;
                              serviceProviderCode?: string | null;
                              source?: { sourceName: string; sourceRef: string };
                              statusCode?:
                                  | "ACTIVE"
                                  | "INACTIVE"
                                  | "CLOSED"
                                  | "CREATED"
                                  | "BLOCKED"
                                  | "WAITING_FOR_CLOSURE_DECISION";
                              statusReasonCode?: string
                              | null;
                              taxResidencyCountryCode?: string | null;
                              tenantCode?: string | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create a new virtual child account

      Creates a new virtual child account for a person

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string

            Idempotency key

            9539eef2-ddd2-4d0e-99c6-c06b32a879cc
            
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
          • personId: string
            ID-1030
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    accountClassCode:
                        | "PERSONAL_DDA"
                        | "BUSINESS_DDA"
                        | "CORPORATE_DDA"
                        | "FINANCIALINSTITUTION_OPS_DDA"
                        | "FI_CONCENTRATION_DDA";
                    accountName?: string
                    | null;
                    currencyCode: "USD";
                    masterAccountId: string;
                };
                "application/json": {
                    accountClassCode: | "PERSONAL_DDA"
                    | "BUSINESS_DDA"
                    | "CORPORATE_DDA"
                    | "FINANCIALINSTITUTION_OPS_DDA"
                    | "FI_CONCENTRATION_DDA";
                    accountName?: string
                    | null;
                    currencyCode: "USD";
                    masterAccountId: string;
                };
                "text/json": {
                    accountClassCode: | "PERSONAL_DDA"
                    | "BUSINESS_DDA"
                    | "CORPORATE_DDA"
                    | "FINANCIALINSTITUTION_OPS_DDA"
                    | "FI_CONCENTRATION_DDA";
                    accountName?: string
                    | null;
                    currencyCode: "USD";
                    masterAccountId: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            accountClassCode?: string | null;
                            accountId?: string | null;
                            accountName?: string | null;
                            accountNumbers?:
                                | {
                                    accountId?: ...;
                                    accountNumber: ...;
                                    accountNumberId?: ...;
                                    accountNumberSubtype?: ...;
                                    countryCode?: ...;
                                    defaultCurrencyCode?: ...;
                                    externalSyncEnabled?: ...;
                                    financialInstitutionId?: ...;
                                    statusCode?: ...;
                                    tenantCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            accountTypeCode?: | "CURRENCY"
                            | "INTERNAL"
                            | "SAVING"
                            | "SHADOW"
                            | "VIRTUAL";
                            accountTypeSetupCode?: string
                            | null;
                            activationDate?: string | null;
                            balances?:
                                | {
                                    accountId: ...;
                                    availableBalanceAmount?: ...;
                                    availableBalanceInDefaultCcy?: ...;
                                    balanceAmount?: ...;
                                    balanceId: ...;
                                    currencyCode: ...;
                                    defaultCurrencyCode?: ...;
                                    negativeBalanceStartDate?: ...;
                                    overdraftLimitAmount?: ...;
                                    reservedAmount?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                            bic?: string
                            | null;
                            counterpartySectorCode?: string | null;
                            customerGroupCode?: string | null;
                            defaultCurrencyCode?: string | null;
                            iban?: string | null;
                            interestMethodAssignmentCode?: string | null;
                            intraOrgCode?: string | null;
                            jurisdictionCountryCode?: string | null;
                            masterAccountId?: string | null;
                            personId?: string | null;
                            personName?: string | null;
                            personTypeCode?: string | null;
                            productCode?: string | null;
                            residencyCode?: string | null;
                            serviceProviderCode?: string | null;
                            source?: { sourceName: string; sourceRef: string };
                            statusCode?:
                                | "ACTIVE"
                                | "INACTIVE"
                                | "CLOSED"
                                | "CREATED"
                                | "BLOCKED"
                                | "WAITING_FOR_CLOSURE_DECISION";
                            statusReasonCode?: string
                            | null;
                            taxResidencyCountryCode?: string | null;
                            tenantCode?: string | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          accountClassCode?: string | null;
                          accountId?: string | null;
                          accountName?: string | null;
                          accountNumbers?:
                              | {
                                  accountId?: ...;
                                  accountNumber: ...;
                                  accountNumberId?: ...;
                                  accountNumberSubtype?: ...;
                                  countryCode?: ...;
                                  defaultCurrencyCode?: ...;
                                  externalSyncEnabled?: ...;
                                  financialInstitutionId?: ...;
                                  statusCode?: ...;
                                  tenantCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          accountTypeCode?: | "CURRENCY"
                          | "INTERNAL"
                          | "SAVING"
                          | "SHADOW"
                          | "VIRTUAL";
                          accountTypeSetupCode?: string
                          | null;
                          activationDate?: string | null;
                          balances?:
                              | {
                                  accountId: ...;
                                  availableBalanceAmount?: ...;
                                  availableBalanceInDefaultCcy?: ...;
                                  balanceAmount?: ...;
                                  balanceId: ...;
                                  currencyCode: ...;
                                  defaultCurrencyCode?: ...;
                                  negativeBalanceStartDate?: ...;
                                  overdraftLimitAmount?: ...;
                                  reservedAmount?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                          bic?: string
                          | null;
                          counterpartySectorCode?: string | null;
                          customerGroupCode?: string | null;
                          defaultCurrencyCode?: string | null;
                          iban?: string | null;
                          interestMethodAssignmentCode?: string | null;
                          intraOrgCode?: string | null;
                          jurisdictionCountryCode?: string | null;
                          masterAccountId?: string | null;
                          personId?: string | null;
                          personName?: string | null;
                          personTypeCode?: string | null;
                          productCode?: string | null;
                          residencyCode?: string | null;
                          serviceProviderCode?: string | null;
                          source?: { sourceName: string; sourceRef: string };
                          statusCode?:
                              | "ACTIVE"
                              | "INACTIVE"
                              | "CLOSED"
                              | "CREATED"
                              | "BLOCKED"
                              | "WAITING_FOR_CLOSURE_DECISION";
                          statusReasonCode?: string
                          | null;
                          taxResidencyCountryCode?: string | null;
                          tenantCode?: string | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/v5/persons/{personId}/accounts": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query: {
                    accountClassCodes?: string[];
                    accountTypeCodes?: (
                        "CURRENCY"
                        | "INTERNAL"
                        | "SAVING"
                        | "SHADOW"
                        | "VIRTUAL"
                    )[];
                    includeAccessRestricted?: boolean;
                    includeClosedAccounts?: boolean;
                    pageNumber: number;
                    pageSize: number;
                    statusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[];
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                endReached?: boolean
                                | null;
                                pageNumber?: number | null;
                                pageSize?: number | null;
                                sort?: { field?: ...; order?: ... }[] | null;
                                total?: number | null;
                                values?:
                                    | {
                                        accessRestricted?: ...;
                                        accountClassCode?: ...;
                                        accountId?: ...;
                                        accountName?: ...;
                                        accountNumbers?: ...;
                                        accountTypeCode?: ...;
                                        accountTypeSetupCode?: ...;
                                        activationDate?: ...;
                                        balances?: ...;
                                        bic?: ...;
                                        counterpartySectorCode?: ...;
                                        customerGroupCode?: ...;
                                        defaultCurrencyCode?: ...;
                                        iban?: ...;
                                        interestMethodAssignmentCode?: ...;
                                        intraOrgCode?: ...;
                                        jurisdictionCountryCode?: ...;
                                        masterAccountId?: ...;
                                        personId?: ...;
                                        personName?: ...;
                                        personTypeCode?: ...;
                                        productCode?: ...;
                                        residencyCode?: ...;
                                        serviceProviderCode?: ...;
                                        source?: ...;
                                        statusCode?: ...;
                                        statusReasonCode?: ...;
                                        taxResidencyCountryCode?: ...;
                                        tenantCode?: ...;
                                    }[]
                                    | null;
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query: {
                  accountClassCodes?: string[];
                  accountTypeCodes?: (
                      "CURRENCY"
                      | "INTERNAL"
                      | "SAVING"
                      | "SHADOW"
                      | "VIRTUAL"
                  )[];
                  includeAccessRestricted?: boolean;
                  includeClosedAccounts?: boolean;
                  pageNumber: number;
                  pageSize: number;
                  statusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[];
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              endReached?: boolean
                              | null;
                              pageNumber?: number | null;
                              pageSize?: number | null;
                              sort?: { field?: ...; order?: ... }[] | null;
                              total?: number | null;
                              values?:
                                  | {
                                      accessRestricted?: ...;
                                      accountClassCode?: ...;
                                      accountId?: ...;
                                      accountName?: ...;
                                      accountNumbers?: ...;
                                      accountTypeCode?: ...;
                                      accountTypeSetupCode?: ...;
                                      activationDate?: ...;
                                      balances?: ...;
                                      bic?: ...;
                                      counterpartySectorCode?: ...;
                                      customerGroupCode?: ...;
                                      defaultCurrencyCode?: ...;
                                      iban?: ...;
                                      interestMethodAssignmentCode?: ...;
                                      intraOrgCode?: ...;
                                      jurisdictionCountryCode?: ...;
                                      masterAccountId?: ...;
                                      personId?: ...;
                                      personName?: ...;
                                      personTypeCode?: ...;
                                      productCode?: ...;
                                      residencyCode?: ...;
                                      serviceProviderCode?: ...;
                                      source?: ...;
                                      statusCode?: ...;
                                      statusReasonCode?: ...;
                                      taxResidencyCountryCode?: ...;
                                      tenantCode?: ...;
                                  }[]
                                  | null;
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Find person accounts by person ID

      Finds all accounts that belong to a person. Supports pagination.

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query: {
                accountClassCodes?: string[];
                accountTypeCodes?: (
                    "CURRENCY"
                    | "INTERNAL"
                    | "SAVING"
                    | "SHADOW"
                    | "VIRTUAL"
                )[];
                includeAccessRestricted?: boolean;
                includeClosedAccounts?: boolean;
                pageNumber: number;
                pageSize: number;
                statusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[];
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
          • personId: string
            ID-1030
            
        • query: {
              accountClassCodes?: string[];
              accountTypeCodes?: (
                  "CURRENCY"
                  | "INTERNAL"
                  | "SAVING"
                  | "SHADOW"
                  | "VIRTUAL"
              )[];
              includeAccessRestricted?: boolean;
              includeClosedAccounts?: boolean;
              pageNumber: number;
              pageSize: number;
              statusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[];
          }
          • OptionalaccountClassCodes?: string[]

            Account class codes

          • OptionalaccountTypeCodes?: ("CURRENCY" | "INTERNAL" | "SAVING" | "SHADOW" | "VIRTUAL")[]

            Account type codes

          • OptionalincludeAccessRestricted?: boolean

            If false then accounts with restricted access are not returned. If true and user has privilege READ_RESTRICTED_DATA then accounts with restricted access are also returned.

          • OptionalincludeClosedAccounts?: boolean

            If true, accounts with CLOSED status are returned. If false, they are not returned. Default value is true

          • pageNumber: number

            Format - int32. Page number

            1
            
          • pageSize: number

            Format - int32. Page size

            20
            
          • OptionalstatusCodes?: ("ACTIVE" | "CLOSED" | "CREATED" | "BLOCKED")[]

            Status codes

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            endReached?: boolean | null;
                            pageNumber?: number | null;
                            pageSize?: number | null;
                            sort?: { field?: ...; order?: ... }[] | null;
                            total?: number | null;
                            values?:
                                | {
                                    accessRestricted?: ...;
                                    accountClassCode?: ...;
                                    accountId?: ...;
                                    accountName?: ...;
                                    accountNumbers?: ...;
                                    accountTypeCode?: ...;
                                    accountTypeSetupCode?: ...;
                                    activationDate?: ...;
                                    balances?: ...;
                                    bic?: ...;
                                    counterpartySectorCode?: ...;
                                    customerGroupCode?: ...;
                                    defaultCurrencyCode?: ...;
                                    iban?: ...;
                                    interestMethodAssignmentCode?: ...;
                                    intraOrgCode?: ...;
                                    jurisdictionCountryCode?: ...;
                                    masterAccountId?: ...;
                                    personId?: ...;
                                    personName?: ...;
                                    personTypeCode?: ...;
                                    productCode?: ...;
                                    residencyCode?: ...;
                                    serviceProviderCode?: ...;
                                    source?: ...;
                                    statusCode?: ...;
                                    statusReasonCode?: ...;
                                    taxResidencyCountryCode?: ...;
                                    tenantCode?: ...;
                                }[]
                                | null;
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          endReached?: boolean | null;
                          pageNumber?: number | null;
                          pageSize?: number | null;
                          sort?: { field?: ...; order?: ... }[] | null;
                          total?: number | null;
                          values?:
                              | {
                                  accessRestricted?: ...;
                                  accountClassCode?: ...;
                                  accountId?: ...;
                                  accountName?: ...;
                                  accountNumbers?: ...;
                                  accountTypeCode?: ...;
                                  accountTypeSetupCode?: ...;
                                  activationDate?: ...;
                                  balances?: ...;
                                  bic?: ...;
                                  counterpartySectorCode?: ...;
                                  customerGroupCode?: ...;
                                  defaultCurrencyCode?: ...;
                                  iban?: ...;
                                  interestMethodAssignmentCode?: ...;
                                  intraOrgCode?: ...;
                                  jurisdictionCountryCode?: ...;
                                  masterAccountId?: ...;
                                  personId?: ...;
                                  personName?: ...;
                                  personTypeCode?: ...;
                                  productCode?: ...;
                                  residencyCode?: ...;
                                  serviceProviderCode?: ...;
                                  source?: ...;
                                  statusCode?: ...;
                                  statusReasonCode?: ...;
                                  taxResidencyCountryCode?: ...;
                                  tenantCode?: ...;
                              }[]
                              | null;
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/accounts/{accountId}/{chain}/usdc-address": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path: { accountId: string; chain: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            address?: string
                            | null;
                            chain?: string | null;
                            createDate?: string | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path: { accountId: string; chain: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          address?: string
                          | null;
                          chain?: string | null;
                          createDate?: string | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Creates an USDC wallet address in the specified chain

      Creates a new USDC wallet address in the specified chain and associates it with the account

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path: { accountId: string; chain: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string; chain: string }
          • accountId: string
          • chain: string
            USDC_ETH
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        address?: string | null;
                        chain?: string | null;
                        createDate?: string | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      address?: string | null;
                      chain?: string | null;
                      createDate?: string | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/accounts/{accountId}/assign-vrn": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path: { accountId: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": { content?: undefined; headers: { [name: string]: unknown } };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[] | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path: { accountId: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": { content?: undefined; headers: { [name: string]: unknown } };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[] | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Assigns a VRN to the specified account.

      Associates a VRN with the target account and updates the system records to reflect the new VRN assignment.

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path: { accountId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { accountId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": { content?: undefined; headers: { [name: string]: unknown } };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: { content?: undefined; headers: { [name: string]: unknown } }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/accounts/usdc-recipient": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/*+json": {
                        address: string;
                        bns: string;
                        chain?: string
                        | null;
                        email: string;
                        nickname: string;
                    };
                    "application/json": {
                        address: string;
                        bns: string;
                        chain?: string
                        | null;
                        email: string;
                        nickname: string;
                    };
                    "text/json": {
                        address: string;
                        bns: string;
                        chain?: string
                        | null;
                        email: string;
                        nickname: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { id: string } };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/*+json": {
                      address: string;
                      bns: string;
                      chain?: string
                      | null;
                      email: string;
                      nickname: string;
                  };
                  "application/json": {
                      address: string;
                      bns: string;
                      chain?: string
                      | null;
                      email: string;
                      nickname: string;
                  };
                  "text/json": {
                      address: string;
                      bns: string;
                      chain?: string
                      | null;
                      email: string;
                      nickname: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: { "application/json": { id: string } };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Creates an USDC recipient

      Creates an USDC recipient

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • requestBody: {
            content: {
                "application/*+json": {
                    address: string;
                    bns: string;
                    chain?: string | null;
                    email: string;
                    nickname: string;
                };
                "application/json": {
                    address: string;
                    bns: string;
                    chain?: string
                    | null;
                    email: string;
                    nickname: string;
                };
                "text/json": {
                    address: string;
                    bns: string;
                    chain?: string
                    | null;
                    email: string;
                    nickname: string;
                };
            };
        }
      • responses: {
            "200": {
                content: { "application/json": { id: string } };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { id: string } };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/payments/{paymentId}/files": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { paymentId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        externalId?: string
                        | null;
                        fileBytes: string;
                        fileName: string;
                        fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                    };
                    "application/json": {
                        externalId?: string
                        | null;
                        fileBytes: string;
                        fileName: string;
                        fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                    };
                    "text/json": {
                        externalId?: string
                        | null;
                        fileBytes: string;
                        fileName: string;
                        fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                addedDate?: string
                                | null;
                                contractSource?: {
                                    contractNumber?: (...) | (...) | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                deleted?: boolean
                                | null;
                                fileId?: string | null;
                                fileName?: string | null;
                                fileTypeCode?: string | null;
                                parameters?: { code?: ...; value?: ... }[] | null;
                                source?: { sourceName: string; sourceRef: string };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { paymentId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      externalId?: string
                      | null;
                      fileBytes: string;
                      fileName: string;
                      fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                  };
                  "application/json": {
                      externalId?: string
                      | null;
                      fileBytes: string;
                      fileName: string;
                      fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                  };
                  "text/json": {
                      externalId?: string
                      | null;
                      fileBytes: string;
                      fileName: string;
                      fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              addedDate?: string
                              | null;
                              contractSource?: {
                                  contractNumber?: (...) | (...) | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              deleted?: boolean
                              | null;
                              fileId?: string | null;
                              fileName?: string | null;
                              fileTypeCode?: string | null;
                              parameters?: { code?: ...; value?: ... }[] | null;
                              source?: { sourceName: string; sourceRef: string };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Upload payment files

      Upload payment files after creating it

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { paymentId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { paymentId: string }
          • paymentId: string

            Payment id

            ID-1030
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    externalId?: string | null;
                    fileBytes: string;
                    fileName: string;
                    fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                };
                "application/json": {
                    externalId?: string
                    | null;
                    fileBytes: string;
                    fileName: string;
                    fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                };
                "text/json": {
                    externalId?: string
                    | null;
                    fileBytes: string;
                    fileName: string;
                    fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            addedDate?: string | null;
                            contractSource?: {
                                contractNumber?: (...) | (...) | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            deleted?: boolean
                            | null;
                            fileId?: string | null;
                            fileName?: string | null;
                            fileTypeCode?: string | null;
                            parameters?: { code?: ...; value?: ... }[] | null;
                            source?: { sourceName: string; sourceRef: string };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          addedDate?: string | null;
                          contractSource?: {
                              contractNumber?: (...) | (...) | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          deleted?: boolean
                          | null;
                          fileId?: string | null;
                          fileName?: string | null;
                          fileTypeCode?: string | null;
                          parameters?: { code?: ...; value?: ... }[] | null;
                          source?: { sourceName: string; sourceRef: string };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/persons/{personId}/custom-fields/value": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": { fieldId: string; fieldValue: string };
                    "application/json": { fieldId: string; fieldValue: string };
                    "text/json": { fieldId: string; fieldValue: string };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": { fieldId: string; fieldValue: string };
                  "application/json": { fieldId: string; fieldValue: string };
                  "text/json": { fieldId: string; fieldValue: string };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Insert or update custom field value

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": { fieldId: string; fieldValue: string };
                "application/json": { fieldId: string; fieldValue: string };
                "text/json": { fieldId: string; fieldValue: string };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/zv1/persons/{personId}/custom-fields/value/batch": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        fieldValues: { fieldId: string; fieldValue: string }[];
                    };
                    "application/json": {
                        fieldValues: { fieldId: string; fieldValue: string }[];
                    };
                    "text/json": { fieldValues: { fieldId: string; fieldValue: string }[] };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: unknown;
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      fieldValues: { fieldId: string; fieldValue: string }[];
                  };
                  "application/json": {
                      fieldValues: { fieldId: string; fieldValue: string }[];
                  };
                  "text/json": { fieldValues: { fieldId: string; fieldValue: string }[] };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: unknown;
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Batch insert or update custom field values

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    fieldValues: { fieldId: string; fieldValue: string }[];
                };
                "application/json": {
                    fieldValues: { fieldId: string; fieldValue: string }[];
                };
                "text/json": { fieldValues: { fieldId: string; fieldValue: string }[] };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: unknown;
                        errors?: string[] | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: unknown;
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/zv1/persons/{personId}/files": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        files: {
                            externalId?: string
                            | null;
                            fileBytes: string;
                            fileName: string;
                            fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                            fileTypeCode:
                                | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "BIOMETRIC_REPORT"
                                | "PROOF_OF_ADDRESS"
                                | "FATCA"
                                | "SOURCE_OF_FUNDS"
                                | "EMPLOYMENT_VERIFICATION_LETTER"
                                | "CRYPTO_WALLET_ADDRESS"
                                | "DOCUMENT_COPY"
                                | "ARTICLES_OF_ASSOCIATION"
                                | "AML_CFT_SANCTIONS_IND_AUDIT"
                                | "AML_CTF_SANCTIONS_POLICY"
                                | "AML_CTF_TRAINING_PROGRAM"
                                | "AUTHORIZED_SIGNATURE_FORM"
                                | "BANKING_LICENSE"
                                | "BANKING_REFERENCE"
                                | "CERTIF_INCORPORATION_REG"
                                | "COMPANY_FISCAL_REG_CERTIF"
                                | "COMPLIANCE_DEPARTMENT"
                                | "COMPLIANCE_OFFICER_RESUME"
                                | "CORPORATE_RESOLUTION"
                                | "FI_CORPORATE_STAMP"
                                | "FI_LICENSE"
                                | "FINANCIAL_STATEMENTS"
                                | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                | "GOOD_STANDING_CERTIFICATION"
                                | "GOV_COMPANY_REG_NUMBER"
                                | "MEM_OF_ASSOCIATION"
                                | "ML_TF_RISK_ASSESSMENT"
                                | "SHARE_CERTIFICATE"
                                | "SOURCE_OF_FUNDS_CERTIFICATION"
                                | "TAX_ID_NUMBER"
                                | "RFI"
                                | "CORPORATE_RECORDS"
                                | "WOLFSBERG_GCBDDQ"
                                | "KYB_REVIEW"
                                | "EDD_CONCENTRATION_FORM";
                        }[];
                    };
                    "application/json": {
                        files: {
                            externalId?: string
                            | null;
                            fileBytes: string;
                            fileName: string;
                            fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                            fileTypeCode:
                                | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "BIOMETRIC_REPORT"
                                | "PROOF_OF_ADDRESS"
                                | "FATCA"
                                | "SOURCE_OF_FUNDS"
                                | "EMPLOYMENT_VERIFICATION_LETTER"
                                | "CRYPTO_WALLET_ADDRESS"
                                | "DOCUMENT_COPY"
                                | "ARTICLES_OF_ASSOCIATION"
                                | "AML_CFT_SANCTIONS_IND_AUDIT"
                                | "AML_CTF_SANCTIONS_POLICY"
                                | "AML_CTF_TRAINING_PROGRAM"
                                | "AUTHORIZED_SIGNATURE_FORM"
                                | "BANKING_LICENSE"
                                | "BANKING_REFERENCE"
                                | "CERTIF_INCORPORATION_REG"
                                | "COMPANY_FISCAL_REG_CERTIF"
                                | "COMPLIANCE_DEPARTMENT"
                                | "COMPLIANCE_OFFICER_RESUME"
                                | "CORPORATE_RESOLUTION"
                                | "FI_CORPORATE_STAMP"
                                | "FI_LICENSE"
                                | "FINANCIAL_STATEMENTS"
                                | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                | "GOOD_STANDING_CERTIFICATION"
                                | "GOV_COMPANY_REG_NUMBER"
                                | "MEM_OF_ASSOCIATION"
                                | "ML_TF_RISK_ASSESSMENT"
                                | "SHARE_CERTIFICATE"
                                | "SOURCE_OF_FUNDS_CERTIFICATION"
                                | "TAX_ID_NUMBER"
                                | "RFI"
                                | "CORPORATE_RECORDS"
                                | "WOLFSBERG_GCBDDQ"
                                | "KYB_REVIEW"
                                | "EDD_CONCENTRATION_FORM";
                        }[];
                    };
                    "text/json": {
                        files: {
                            externalId?: string
                            | null;
                            fileBytes: string;
                            fileName: string;
                            fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                            fileTypeCode:
                                | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "BIOMETRIC_REPORT"
                                | "PROOF_OF_ADDRESS"
                                | "FATCA"
                                | "SOURCE_OF_FUNDS"
                                | "EMPLOYMENT_VERIFICATION_LETTER"
                                | "CRYPTO_WALLET_ADDRESS"
                                | "DOCUMENT_COPY"
                                | "ARTICLES_OF_ASSOCIATION"
                                | "AML_CFT_SANCTIONS_IND_AUDIT"
                                | "AML_CTF_SANCTIONS_POLICY"
                                | "AML_CTF_TRAINING_PROGRAM"
                                | "AUTHORIZED_SIGNATURE_FORM"
                                | "BANKING_LICENSE"
                                | "BANKING_REFERENCE"
                                | "CERTIF_INCORPORATION_REG"
                                | "COMPANY_FISCAL_REG_CERTIF"
                                | "COMPLIANCE_DEPARTMENT"
                                | "COMPLIANCE_OFFICER_RESUME"
                                | "CORPORATE_RESOLUTION"
                                | "FI_CORPORATE_STAMP"
                                | "FI_LICENSE"
                                | "FINANCIAL_STATEMENTS"
                                | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                | "GOOD_STANDING_CERTIFICATION"
                                | "GOV_COMPANY_REG_NUMBER"
                                | "MEM_OF_ASSOCIATION"
                                | "ML_TF_RISK_ASSESSMENT"
                                | "SHARE_CERTIFICATE"
                                | "SOURCE_OF_FUNDS_CERTIFICATION"
                                | "TAX_ID_NUMBER"
                                | "RFI"
                                | "CORPORATE_RECORDS"
                                | "WOLFSBERG_GCBDDQ"
                                | "KYB_REVIEW"
                                | "EDD_CONCENTRATION_FORM";
                        }[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            files?: {
                                externalId?: string | null;
                                fileBytes?: string | null;
                                fileId?: string;
                                fileName?: string;
                                fileTypeCode?:
                                    | "PASSPORT"
                                    | "DRIVER_LICENCE"
                                    | "ID_CARD"
                                    | "BIOMETRIC_REPORT"
                                    | "PROOF_OF_ADDRESS"
                                    | "FATCA"
                                    | "SOURCE_OF_FUNDS"
                                    | "EMPLOYMENT_VERIFICATION_LETTER"
                                    | "CRYPTO_WALLET_ADDRESS"
                                    | "DOCUMENT_COPY"
                                    | "ARTICLES_OF_ASSOCIATION"
                                    | "AML_CFT_SANCTIONS_IND_AUDIT"
                                    | "AML_CTF_SANCTIONS_POLICY"
                                    | "AML_CTF_TRAINING_PROGRAM"
                                    | "AUTHORIZED_SIGNATURE_FORM"
                                    | "BANKING_LICENSE"
                                    | "BANKING_REFERENCE"
                                    | "CERTIF_INCORPORATION_REG"
                                    | "COMPANY_FISCAL_REG_CERTIF"
                                    | "COMPLIANCE_DEPARTMENT"
                                    | "COMPLIANCE_OFFICER_RESUME"
                                    | "CORPORATE_RESOLUTION"
                                    | "FI_CORPORATE_STAMP"
                                    | "FI_LICENSE"
                                    | "FINANCIAL_STATEMENTS"
                                    | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                    | "GOOD_STANDING_CERTIFICATION"
                                    | "GOV_COMPANY_REG_NUMBER"
                                    | "MEM_OF_ASSOCIATION"
                                    | "ML_TF_RISK_ASSESSMENT"
                                    | "SHARE_CERTIFICATE"
                                    | "SOURCE_OF_FUNDS_CERTIFICATION"
                                    | "TAX_ID_NUMBER"
                                    | "RFI"
                                    | "CORPORATE_RECORDS"
                                    | "WOLFSBERG_GCBDDQ"
                                    | "KYB_REVIEW"
                                    | "EDD_CONCENTRATION_FORM";
                            }[];
                            validationErrors?: | {
                                errors?: (...)[]
                                | null;
                                field?: string | null;
                            }[]
                            | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      files: {
                          externalId?: string
                          | null;
                          fileBytes: string;
                          fileName: string;
                          fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                          fileTypeCode:
                              | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "BIOMETRIC_REPORT"
                              | "PROOF_OF_ADDRESS"
                              | "FATCA"
                              | "SOURCE_OF_FUNDS"
                              | "EMPLOYMENT_VERIFICATION_LETTER"
                              | "CRYPTO_WALLET_ADDRESS"
                              | "DOCUMENT_COPY"
                              | "ARTICLES_OF_ASSOCIATION"
                              | "AML_CFT_SANCTIONS_IND_AUDIT"
                              | "AML_CTF_SANCTIONS_POLICY"
                              | "AML_CTF_TRAINING_PROGRAM"
                              | "AUTHORIZED_SIGNATURE_FORM"
                              | "BANKING_LICENSE"
                              | "BANKING_REFERENCE"
                              | "CERTIF_INCORPORATION_REG"
                              | "COMPANY_FISCAL_REG_CERTIF"
                              | "COMPLIANCE_DEPARTMENT"
                              | "COMPLIANCE_OFFICER_RESUME"
                              | "CORPORATE_RESOLUTION"
                              | "FI_CORPORATE_STAMP"
                              | "FI_LICENSE"
                              | "FINANCIAL_STATEMENTS"
                              | "FINCEN_CERTIF_CORRESP_ACC_FI"
                              | "GOOD_STANDING_CERTIFICATION"
                              | "GOV_COMPANY_REG_NUMBER"
                              | "MEM_OF_ASSOCIATION"
                              | "ML_TF_RISK_ASSESSMENT"
                              | "SHARE_CERTIFICATE"
                              | "SOURCE_OF_FUNDS_CERTIFICATION"
                              | "TAX_ID_NUMBER"
                              | "RFI"
                              | "CORPORATE_RECORDS"
                              | "WOLFSBERG_GCBDDQ"
                              | "KYB_REVIEW"
                              | "EDD_CONCENTRATION_FORM";
                      }[];
                  };
                  "application/json": {
                      files: {
                          externalId?: string
                          | null;
                          fileBytes: string;
                          fileName: string;
                          fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                          fileTypeCode:
                              | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "BIOMETRIC_REPORT"
                              | "PROOF_OF_ADDRESS"
                              | "FATCA"
                              | "SOURCE_OF_FUNDS"
                              | "EMPLOYMENT_VERIFICATION_LETTER"
                              | "CRYPTO_WALLET_ADDRESS"
                              | "DOCUMENT_COPY"
                              | "ARTICLES_OF_ASSOCIATION"
                              | "AML_CFT_SANCTIONS_IND_AUDIT"
                              | "AML_CTF_SANCTIONS_POLICY"
                              | "AML_CTF_TRAINING_PROGRAM"
                              | "AUTHORIZED_SIGNATURE_FORM"
                              | "BANKING_LICENSE"
                              | "BANKING_REFERENCE"
                              | "CERTIF_INCORPORATION_REG"
                              | "COMPANY_FISCAL_REG_CERTIF"
                              | "COMPLIANCE_DEPARTMENT"
                              | "COMPLIANCE_OFFICER_RESUME"
                              | "CORPORATE_RESOLUTION"
                              | "FI_CORPORATE_STAMP"
                              | "FI_LICENSE"
                              | "FINANCIAL_STATEMENTS"
                              | "FINCEN_CERTIF_CORRESP_ACC_FI"
                              | "GOOD_STANDING_CERTIFICATION"
                              | "GOV_COMPANY_REG_NUMBER"
                              | "MEM_OF_ASSOCIATION"
                              | "ML_TF_RISK_ASSESSMENT"
                              | "SHARE_CERTIFICATE"
                              | "SOURCE_OF_FUNDS_CERTIFICATION"
                              | "TAX_ID_NUMBER"
                              | "RFI"
                              | "CORPORATE_RECORDS"
                              | "WOLFSBERG_GCBDDQ"
                              | "KYB_REVIEW"
                              | "EDD_CONCENTRATION_FORM";
                      }[];
                  };
                  "text/json": {
                      files: {
                          externalId?: string
                          | null;
                          fileBytes: string;
                          fileName: string;
                          fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                          fileTypeCode:
                              | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "BIOMETRIC_REPORT"
                              | "PROOF_OF_ADDRESS"
                              | "FATCA"
                              | "SOURCE_OF_FUNDS"
                              | "EMPLOYMENT_VERIFICATION_LETTER"
                              | "CRYPTO_WALLET_ADDRESS"
                              | "DOCUMENT_COPY"
                              | "ARTICLES_OF_ASSOCIATION"
                              | "AML_CFT_SANCTIONS_IND_AUDIT"
                              | "AML_CTF_SANCTIONS_POLICY"
                              | "AML_CTF_TRAINING_PROGRAM"
                              | "AUTHORIZED_SIGNATURE_FORM"
                              | "BANKING_LICENSE"
                              | "BANKING_REFERENCE"
                              | "CERTIF_INCORPORATION_REG"
                              | "COMPANY_FISCAL_REG_CERTIF"
                              | "COMPLIANCE_DEPARTMENT"
                              | "COMPLIANCE_OFFICER_RESUME"
                              | "CORPORATE_RESOLUTION"
                              | "FI_CORPORATE_STAMP"
                              | "FI_LICENSE"
                              | "FINANCIAL_STATEMENTS"
                              | "FINCEN_CERTIF_CORRESP_ACC_FI"
                              | "GOOD_STANDING_CERTIFICATION"
                              | "GOV_COMPANY_REG_NUMBER"
                              | "MEM_OF_ASSOCIATION"
                              | "ML_TF_RISK_ASSESSMENT"
                              | "SHARE_CERTIFICATE"
                              | "SOURCE_OF_FUNDS_CERTIFICATION"
                              | "TAX_ID_NUMBER"
                              | "RFI"
                              | "CORPORATE_RECORDS"
                              | "WOLFSBERG_GCBDDQ"
                              | "KYB_REVIEW"
                              | "EDD_CONCENTRATION_FORM";
                      }[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          files?: {
                              externalId?: string | null;
                              fileBytes?: string | null;
                              fileId?: string;
                              fileName?: string;
                              fileTypeCode?:
                                  | "PASSPORT"
                                  | "DRIVER_LICENCE"
                                  | "ID_CARD"
                                  | "BIOMETRIC_REPORT"
                                  | "PROOF_OF_ADDRESS"
                                  | "FATCA"
                                  | "SOURCE_OF_FUNDS"
                                  | "EMPLOYMENT_VERIFICATION_LETTER"
                                  | "CRYPTO_WALLET_ADDRESS"
                                  | "DOCUMENT_COPY"
                                  | "ARTICLES_OF_ASSOCIATION"
                                  | "AML_CFT_SANCTIONS_IND_AUDIT"
                                  | "AML_CTF_SANCTIONS_POLICY"
                                  | "AML_CTF_TRAINING_PROGRAM"
                                  | "AUTHORIZED_SIGNATURE_FORM"
                                  | "BANKING_LICENSE"
                                  | "BANKING_REFERENCE"
                                  | "CERTIF_INCORPORATION_REG"
                                  | "COMPANY_FISCAL_REG_CERTIF"
                                  | "COMPLIANCE_DEPARTMENT"
                                  | "COMPLIANCE_OFFICER_RESUME"
                                  | "CORPORATE_RESOLUTION"
                                  | "FI_CORPORATE_STAMP"
                                  | "FI_LICENSE"
                                  | "FINANCIAL_STATEMENTS"
                                  | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                  | "GOOD_STANDING_CERTIFICATION"
                                  | "GOV_COMPANY_REG_NUMBER"
                                  | "MEM_OF_ASSOCIATION"
                                  | "ML_TF_RISK_ASSESSMENT"
                                  | "SHARE_CERTIFICATE"
                                  | "SOURCE_OF_FUNDS_CERTIFICATION"
                                  | "TAX_ID_NUMBER"
                                  | "RFI"
                                  | "CORPORATE_RECORDS"
                                  | "WOLFSBERG_GCBDDQ"
                                  | "KYB_REVIEW"
                                  | "EDD_CONCENTRATION_FORM";
                          }[];
                          validationErrors?: | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Upload KYC files

      Upload a person's KYC files before creating a virtual account

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
          • personId: string

            Person id

            ID-1030
            
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    files: {
                        externalId?: string | null;
                        fileBytes: string;
                        fileName: string;
                        fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                        fileTypeCode:
                            | "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD"
                            | "BIOMETRIC_REPORT"
                            | "PROOF_OF_ADDRESS"
                            | "FATCA"
                            | "SOURCE_OF_FUNDS"
                            | "EMPLOYMENT_VERIFICATION_LETTER"
                            | "CRYPTO_WALLET_ADDRESS"
                            | "DOCUMENT_COPY"
                            | "ARTICLES_OF_ASSOCIATION"
                            | "AML_CFT_SANCTIONS_IND_AUDIT"
                            | "AML_CTF_SANCTIONS_POLICY"
                            | "AML_CTF_TRAINING_PROGRAM"
                            | "AUTHORIZED_SIGNATURE_FORM"
                            | "BANKING_LICENSE"
                            | "BANKING_REFERENCE"
                            | "CERTIF_INCORPORATION_REG"
                            | "COMPANY_FISCAL_REG_CERTIF"
                            | "COMPLIANCE_DEPARTMENT"
                            | "COMPLIANCE_OFFICER_RESUME"
                            | "CORPORATE_RESOLUTION"
                            | "FI_CORPORATE_STAMP"
                            | "FI_LICENSE"
                            | "FINANCIAL_STATEMENTS"
                            | "FINCEN_CERTIF_CORRESP_ACC_FI"
                            | "GOOD_STANDING_CERTIFICATION"
                            | "GOV_COMPANY_REG_NUMBER"
                            | "MEM_OF_ASSOCIATION"
                            | "ML_TF_RISK_ASSESSMENT"
                            | "SHARE_CERTIFICATE"
                            | "SOURCE_OF_FUNDS_CERTIFICATION"
                            | "TAX_ID_NUMBER"
                            | "RFI"
                            | "CORPORATE_RECORDS"
                            | "WOLFSBERG_GCBDDQ"
                            | "KYB_REVIEW"
                            | "EDD_CONCENTRATION_FORM";
                    }[];
                };
                "application/json": {
                    files: {
                        externalId?: string
                        | null;
                        fileBytes: string;
                        fileName: string;
                        fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                        fileTypeCode:
                            | "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD"
                            | "BIOMETRIC_REPORT"
                            | "PROOF_OF_ADDRESS"
                            | "FATCA"
                            | "SOURCE_OF_FUNDS"
                            | "EMPLOYMENT_VERIFICATION_LETTER"
                            | "CRYPTO_WALLET_ADDRESS"
                            | "DOCUMENT_COPY"
                            | "ARTICLES_OF_ASSOCIATION"
                            | "AML_CFT_SANCTIONS_IND_AUDIT"
                            | "AML_CTF_SANCTIONS_POLICY"
                            | "AML_CTF_TRAINING_PROGRAM"
                            | "AUTHORIZED_SIGNATURE_FORM"
                            | "BANKING_LICENSE"
                            | "BANKING_REFERENCE"
                            | "CERTIF_INCORPORATION_REG"
                            | "COMPANY_FISCAL_REG_CERTIF"
                            | "COMPLIANCE_DEPARTMENT"
                            | "COMPLIANCE_OFFICER_RESUME"
                            | "CORPORATE_RESOLUTION"
                            | "FI_CORPORATE_STAMP"
                            | "FI_LICENSE"
                            | "FINANCIAL_STATEMENTS"
                            | "FINCEN_CERTIF_CORRESP_ACC_FI"
                            | "GOOD_STANDING_CERTIFICATION"
                            | "GOV_COMPANY_REG_NUMBER"
                            | "MEM_OF_ASSOCIATION"
                            | "ML_TF_RISK_ASSESSMENT"
                            | "SHARE_CERTIFICATE"
                            | "SOURCE_OF_FUNDS_CERTIFICATION"
                            | "TAX_ID_NUMBER"
                            | "RFI"
                            | "CORPORATE_RECORDS"
                            | "WOLFSBERG_GCBDDQ"
                            | "KYB_REVIEW"
                            | "EDD_CONCENTRATION_FORM";
                    }[];
                };
                "text/json": {
                    files: {
                        externalId?: string
                        | null;
                        fileBytes: string;
                        fileName: string;
                        fileType: "PDF" | "JSON" | "JPEG" | "PNG";
                        fileTypeCode:
                            | "PASSPORT"
                            | "DRIVER_LICENCE"
                            | "ID_CARD"
                            | "BIOMETRIC_REPORT"
                            | "PROOF_OF_ADDRESS"
                            | "FATCA"
                            | "SOURCE_OF_FUNDS"
                            | "EMPLOYMENT_VERIFICATION_LETTER"
                            | "CRYPTO_WALLET_ADDRESS"
                            | "DOCUMENT_COPY"
                            | "ARTICLES_OF_ASSOCIATION"
                            | "AML_CFT_SANCTIONS_IND_AUDIT"
                            | "AML_CTF_SANCTIONS_POLICY"
                            | "AML_CTF_TRAINING_PROGRAM"
                            | "AUTHORIZED_SIGNATURE_FORM"
                            | "BANKING_LICENSE"
                            | "BANKING_REFERENCE"
                            | "CERTIF_INCORPORATION_REG"
                            | "COMPANY_FISCAL_REG_CERTIF"
                            | "COMPLIANCE_DEPARTMENT"
                            | "COMPLIANCE_OFFICER_RESUME"
                            | "CORPORATE_RESOLUTION"
                            | "FI_CORPORATE_STAMP"
                            | "FI_LICENSE"
                            | "FINANCIAL_STATEMENTS"
                            | "FINCEN_CERTIF_CORRESP_ACC_FI"
                            | "GOOD_STANDING_CERTIFICATION"
                            | "GOV_COMPANY_REG_NUMBER"
                            | "MEM_OF_ASSOCIATION"
                            | "ML_TF_RISK_ASSESSMENT"
                            | "SHARE_CERTIFICATE"
                            | "SOURCE_OF_FUNDS_CERTIFICATION"
                            | "TAX_ID_NUMBER"
                            | "RFI"
                            | "CORPORATE_RECORDS"
                            | "WOLFSBERG_GCBDDQ"
                            | "KYB_REVIEW"
                            | "EDD_CONCENTRATION_FORM";
                    }[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        errors?: string[] | null;
                        files?: {
                            externalId?: string | null;
                            fileBytes?: string | null;
                            fileId?: string;
                            fileName?: string;
                            fileTypeCode?:
                                | "PASSPORT"
                                | "DRIVER_LICENCE"
                                | "ID_CARD"
                                | "BIOMETRIC_REPORT"
                                | "PROOF_OF_ADDRESS"
                                | "FATCA"
                                | "SOURCE_OF_FUNDS"
                                | "EMPLOYMENT_VERIFICATION_LETTER"
                                | "CRYPTO_WALLET_ADDRESS"
                                | "DOCUMENT_COPY"
                                | "ARTICLES_OF_ASSOCIATION"
                                | "AML_CFT_SANCTIONS_IND_AUDIT"
                                | "AML_CTF_SANCTIONS_POLICY"
                                | "AML_CTF_TRAINING_PROGRAM"
                                | "AUTHORIZED_SIGNATURE_FORM"
                                | "BANKING_LICENSE"
                                | "BANKING_REFERENCE"
                                | "CERTIF_INCORPORATION_REG"
                                | "COMPANY_FISCAL_REG_CERTIF"
                                | "COMPLIANCE_DEPARTMENT"
                                | "COMPLIANCE_OFFICER_RESUME"
                                | "CORPORATE_RESOLUTION"
                                | "FI_CORPORATE_STAMP"
                                | "FI_LICENSE"
                                | "FINANCIAL_STATEMENTS"
                                | "FINCEN_CERTIF_CORRESP_ACC_FI"
                                | "GOOD_STANDING_CERTIFICATION"
                                | "GOV_COMPANY_REG_NUMBER"
                                | "MEM_OF_ASSOCIATION"
                                | "ML_TF_RISK_ASSESSMENT"
                                | "SHARE_CERTIFICATE"
                                | "SOURCE_OF_FUNDS_CERTIFICATION"
                                | "TAX_ID_NUMBER"
                                | "RFI"
                                | "CORPORATE_RECORDS"
                                | "WOLFSBERG_GCBDDQ"
                                | "KYB_REVIEW"
                                | "EDD_CONCENTRATION_FORM";
                        }[];
                        validationErrors?: | { errors?: (...)[]
                        | null; field?: string | null }[]
                        | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      files?: {
                          externalId?: string | null;
                          fileBytes?: string | null;
                          fileId?: string;
                          fileName?: string;
                          fileTypeCode?:
                              | "PASSPORT"
                              | "DRIVER_LICENCE"
                              | "ID_CARD"
                              | "BIOMETRIC_REPORT"
                              | "PROOF_OF_ADDRESS"
                              | "FATCA"
                              | "SOURCE_OF_FUNDS"
                              | "EMPLOYMENT_VERIFICATION_LETTER"
                              | "CRYPTO_WALLET_ADDRESS"
                              | "DOCUMENT_COPY"
                              | "ARTICLES_OF_ASSOCIATION"
                              | "AML_CFT_SANCTIONS_IND_AUDIT"
                              | "AML_CTF_SANCTIONS_POLICY"
                              | "AML_CTF_TRAINING_PROGRAM"
                              | "AUTHORIZED_SIGNATURE_FORM"
                              | "BANKING_LICENSE"
                              | "BANKING_REFERENCE"
                              | "CERTIF_INCORPORATION_REG"
                              | "COMPANY_FISCAL_REG_CERTIF"
                              | "COMPLIANCE_DEPARTMENT"
                              | "COMPLIANCE_OFFICER_RESUME"
                              | "CORPORATE_RESOLUTION"
                              | "FI_CORPORATE_STAMP"
                              | "FI_LICENSE"
                              | "FINANCIAL_STATEMENTS"
                              | "FINCEN_CERTIF_CORRESP_ACC_FI"
                              | "GOOD_STANDING_CERTIFICATION"
                              | "GOV_COMPANY_REG_NUMBER"
                              | "MEM_OF_ASSOCIATION"
                              | "ML_TF_RISK_ASSESSMENT"
                              | "SHARE_CERTIFICATE"
                              | "SOURCE_OF_FUNDS_CERTIFICATION"
                              | "TAX_ID_NUMBER"
                              | "RFI"
                              | "CORPORATE_RECORDS"
                              | "WOLFSBERG_GCBDDQ"
                              | "KYB_REVIEW"
                              | "EDD_CONCENTRATION_FORM";
                      }[];
                      validationErrors?: | { errors?: (...)[]
                      | null; field?: string | null }[]
                      | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/zv1/persons/{personId}/identificationNumbers": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        expiryDate: string;
                        idCountryCode: string;
                        idNumber: string;
                        idTypeCode: "PASSPORT"
                        | "DRIVER_LICENCE"
                        | "ID_CARD";
                        issuingDate?: string | null;
                    };
                    "application/json": {
                        expiryDate: string;
                        idCountryCode: string;
                        idNumber: string;
                        idTypeCode: "PASSPORT"
                        | "DRIVER_LICENCE"
                        | "ID_CARD";
                        issuingDate?: string | null;
                    };
                    "text/json": {
                        expiryDate: string;
                        idCountryCode: string;
                        idNumber: string;
                        idTypeCode: "PASSPORT"
                        | "DRIVER_LICENCE"
                        | "ID_CARD";
                        issuingDate?: string | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                docuId?: string
                                | null;
                                documentTypeCode?: string | null;
                                expiryDate?: string | null;
                                issuingCountry?: string | null;
                                number?: string | null;
                                personId?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      expiryDate: string;
                      idCountryCode: string;
                      idNumber: string;
                      idTypeCode: "PASSPORT"
                      | "DRIVER_LICENCE"
                      | "ID_CARD";
                      issuingDate?: string | null;
                  };
                  "application/json": {
                      expiryDate: string;
                      idCountryCode: string;
                      idNumber: string;
                      idTypeCode: "PASSPORT"
                      | "DRIVER_LICENCE"
                      | "ID_CARD";
                      issuingDate?: string | null;
                  };
                  "text/json": {
                      expiryDate: string;
                      idCountryCode: string;
                      idNumber: string;
                      idTypeCode: "PASSPORT"
                      | "DRIVER_LICENCE"
                      | "ID_CARD";
                      issuingDate?: string | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              docuId?: string
                              | null;
                              documentTypeCode?: string | null;
                              expiryDate?: string | null;
                              issuingCountry?: string | null;
                              number?: string | null;
                              personId?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update person identification number

      Add identification number information for a person like Expiry Date

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    expiryDate: string;
                    idCountryCode: string;
                    idNumber: string;
                    idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                    issuingDate?: string | null;
                };
                "application/json": {
                    expiryDate: string;
                    idCountryCode: string;
                    idNumber: string;
                    idTypeCode: "PASSPORT"
                    | "DRIVER_LICENCE"
                    | "ID_CARD";
                    issuingDate?: string | null;
                };
                "text/json": {
                    expiryDate: string;
                    idCountryCode: string;
                    idNumber: string;
                    idTypeCode: "PASSPORT"
                    | "DRIVER_LICENCE"
                    | "ID_CARD";
                    issuingDate?: string | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            docuId?: string | null;
                            documentTypeCode?: string | null;
                            expiryDate?: string | null;
                            issuingCountry?: string | null;
                            number?: string | null;
                            personId?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          docuId?: string | null;
                          documentTypeCode?: string | null;
                          expiryDate?: string | null;
                          issuingCountry?: string | null;
                          number?: string | null;
                          personId?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/api/zv1/persons/{personId}/taxNumbers": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-request-id"?: string; "x-tenant-id"?: string };
                path: { personId: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        primary: boolean;
                        taxCountryCode: string;
                        taxNumber: string;
                        taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                        | "TAX_CODE"
                        | "SSN";
                    };
                    "application/json": {
                        primary: boolean;
                        taxCountryCode: string;
                        taxNumber: string;
                        taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                        | "TAX_CODE"
                        | "SSN";
                    };
                    "text/json": {
                        primary: boolean;
                        taxCountryCode: string;
                        taxNumber: string;
                        taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                        | "TAX_CODE"
                        | "SSN";
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                personId?: string
                                | null;
                                primary?: boolean | null;
                                taxCountryCode?: string | null;
                                taxNumber?: string | null;
                                taxNumberId?: string | null;
                                taxNumberTypeCode?: string | null;
                                validityRange?: {
                                    endTime?: (...) | (...) | (...);
                                    startTime?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-request-id"?: string; "x-tenant-id"?: string };
              path: { personId: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      primary: boolean;
                      taxCountryCode: string;
                      taxNumber: string;
                      taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                      | "TAX_CODE"
                      | "SSN";
                  };
                  "application/json": {
                      primary: boolean;
                      taxCountryCode: string;
                      taxNumber: string;
                      taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                      | "TAX_CODE"
                      | "SSN";
                  };
                  "text/json": {
                      primary: boolean;
                      taxCountryCode: string;
                      taxNumber: string;
                      taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                      | "TAX_CODE"
                      | "SSN";
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              personId?: string
                              | null;
                              primary?: boolean | null;
                              taxCountryCode?: string | null;
                              taxNumber?: string | null;
                              taxNumberId?: string | null;
                              taxNumberTypeCode?: string | null;
                              validityRange?: {
                                  endTime?: (...) | (...) | (...);
                                  startTime?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create new tax number

      • parameters: {
            cookie?: undefined;
            header?: { "x-request-id"?: string; "x-tenant-id"?: string };
            path: { personId: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-request-id"?: string; "x-tenant-id"?: string }
          • Optionalx-request-id?: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • path: { personId: string }
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    primary: boolean;
                    taxCountryCode: string;
                    taxNumber: string;
                    taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER" | "TAX_CODE" | "SSN";
                };
                "application/json": {
                    primary: boolean;
                    taxCountryCode: string;
                    taxNumber: string;
                    taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                    | "TAX_CODE"
                    | "SSN";
                };
                "text/json": {
                    primary: boolean;
                    taxCountryCode: string;
                    taxNumber: string;
                    taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                    | "TAX_CODE"
                    | "SSN";
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            personId?: string | null;
                            primary?: boolean | null;
                            taxCountryCode?: string | null;
                            taxNumber?: string | null;
                            taxNumberId?: string | null;
                            taxNumberTypeCode?: string | null;
                            validityRange?: {
                                endTime?: (...) | (...) | (...);
                                startTime?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          personId?: string | null;
                          primary?: boolean | null;
                          taxCountryCode?: string | null;
                          taxNumber?: string | null;
                          taxNumberId?: string | null;
                          taxNumberTypeCode?: string | null;
                          validityRange?: {
                              endTime?: (...) | (...) | (...);
                              startTime?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/persons/legal": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        addresses?: | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            stateRegion?: string
                            | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                        counterpartySectorCode?: string
                        | null;
                        identificationNumbers?:
                            | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                            | null;
                        name?: string | null;
                        registrationDate?: string | null;
                        taxNumbers?:
                            | {
                                primary?: boolean
                                | null;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode?:
                                    | "TAX_IDENTIFICATION_NUMBER"
                                    | "VAT_NUMBER"
                                    | "NATIONAL_INSURANCE_NUMBER";
                            }[]
                            | null;
                        webAddress?: string
                        | null;
                    };
                    "application/json": {
                        addresses?: | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            stateRegion?: string
                            | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                        counterpartySectorCode?: string
                        | null;
                        identificationNumbers?:
                            | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                            | null;
                        name?: string | null;
                        registrationDate?: string | null;
                        taxNumbers?:
                            | {
                                primary?: boolean
                                | null;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode?:
                                    | "TAX_IDENTIFICATION_NUMBER"
                                    | "VAT_NUMBER"
                                    | "NATIONAL_INSURANCE_NUMBER";
                            }[]
                            | null;
                        webAddress?: string
                        | null;
                    };
                    "text/json": {
                        addresses?: | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            stateRegion?: string
                            | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                        counterpartySectorCode?: string
                        | null;
                        identificationNumbers?:
                            | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                            | null;
                        name?: string | null;
                        registrationDate?: string | null;
                        taxNumbers?:
                            | {
                                primary?: boolean
                                | null;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode?:
                                    | "TAX_IDENTIFICATION_NUMBER"
                                    | "VAT_NUMBER"
                                    | "NATIONAL_INSURANCE_NUMBER";
                            }[]
                            | null;
                        webAddress?: string
                        | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                additionalContacts?:
                                    | {
                                        additionalContactId?: ...;
                                        contactTypeCode?: ...;
                                        description?: ...;
                                        email?: ...;
                                        personId?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        preferredMethodOfContact?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                additionalInfo?: {
                                    birthDate?: (...)
                                    | (...)
                                    | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                addresses?: | {
                                    addressId?: ...;
                                    addressTypeCode?: ...;
                                    apartmentNumber?: ...;
                                    buildingName?: ...;
                                    buildingNumber?: ...;
                                    cityCounty?: ...;
                                    countryCode?: ...;
                                    department?: ...;
                                    district?: ...;
                                    floor?: ...;
                                    moveInDate?: ...;
                                    personId?: ...;
                                    postBox?: ...;
                                    stateRegion?: ...;
                                    street1?: ...;
                                    street2?: ...;
                                    streetName?: ...;
                                    structured?: ...;
                                    subDepartment?: ...;
                                    townLocationName?: ...;
                                    validityRange?: ...;
                                    zip?: ...;
                                }[]
                                | null;
                                creationDate?: string
                                | null;
                                documents?:
                                    | {
                                        docuId?: ...;
                                        documentTypeCode?: ...;
                                        expiryDate?: ...;
                                        issuingCountry?: ...;
                                        number?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                forgotten?: boolean
                                | null;
                                fullName?: string | null;
                                home?: {
                                    buildingTypeCode?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                };
                                identificationNumbers?: | {
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    idNumberId?: ...;
                                    personId?: ...;
                                    primary?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                legalForm?: string
                                | null;
                                mainPersonId?: string | null;
                                personalInfo?: {
                                    dependantPersons?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                };
                                personGroupCodes?: | {
                                    personGroupCode: ...;
                                    personGroupId?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                personId?: string
                                | null;
                                relationships?:
                                    | {
                                        additionalData?: ...;
                                        beneficiary?: ...;
                                        parent?: ...;
                                        parentPersonId?: ...;
                                        percentageOfShares?: ...;
                                        percentageOfSignature?: ...;
                                        person?: ...;
                                        personId?: ...;
                                        personRelationshipId?: ...;
                                        relationTypeCode?: ...;
                                        representingRange?: ...;
                                        role?: ...;
                                        statusCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                source?: {
                                    sourceLink?: (...)
                                    | (...)
                                    | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                statusCode?: string
                                | null;
                                taxNumbers?:
                                    | {
                                        personId?: ...;
                                        primary?: ...;
                                        taxCountryCode?: ...;
                                        taxNumber?: ...;
                                        taxNumberId?: ...;
                                        taxNumberTypeCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                tenantCode?: string
                                | null;
                                work?: {
                                    activityCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      addresses?: | {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          stateRegion?: string
                          | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[]
                      | null;
                      counterpartySectorCode?: string
                      | null;
                      identificationNumbers?:
                          | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                          | null;
                      name?: string | null;
                      registrationDate?: string | null;
                      taxNumbers?:
                          | {
                              primary?: boolean
                              | null;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode?:
                                  | "TAX_IDENTIFICATION_NUMBER"
                                  | "VAT_NUMBER"
                                  | "NATIONAL_INSURANCE_NUMBER";
                          }[]
                          | null;
                      webAddress?: string
                      | null;
                  };
                  "application/json": {
                      addresses?: | {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          stateRegion?: string
                          | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[]
                      | null;
                      counterpartySectorCode?: string
                      | null;
                      identificationNumbers?:
                          | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                          | null;
                      name?: string | null;
                      registrationDate?: string | null;
                      taxNumbers?:
                          | {
                              primary?: boolean
                              | null;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode?:
                                  | "TAX_IDENTIFICATION_NUMBER"
                                  | "VAT_NUMBER"
                                  | "NATIONAL_INSURANCE_NUMBER";
                          }[]
                          | null;
                      webAddress?: string
                      | null;
                  };
                  "text/json": {
                      addresses?: | {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          stateRegion?: string
                          | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[]
                      | null;
                      counterpartySectorCode?: string
                      | null;
                      identificationNumbers?:
                          | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                          | null;
                      name?: string | null;
                      registrationDate?: string | null;
                      taxNumbers?:
                          | {
                              primary?: boolean
                              | null;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode?:
                                  | "TAX_IDENTIFICATION_NUMBER"
                                  | "VAT_NUMBER"
                                  | "NATIONAL_INSURANCE_NUMBER";
                          }[]
                          | null;
                      webAddress?: string
                      | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              additionalContacts?:
                                  | {
                                      additionalContactId?: ...;
                                      contactTypeCode?: ...;
                                      description?: ...;
                                      email?: ...;
                                      personId?: ...;
                                      phoneCountryCode?: ...;
                                      phoneNumber?: ...;
                                      preferredMethodOfContact?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              additionalInfo?: {
                                  birthDate?: (...)
                                  | (...)
                                  | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              addresses?: | {
                                  addressId?: ...;
                                  addressTypeCode?: ...;
                                  apartmentNumber?: ...;
                                  buildingName?: ...;
                                  buildingNumber?: ...;
                                  cityCounty?: ...;
                                  countryCode?: ...;
                                  department?: ...;
                                  district?: ...;
                                  floor?: ...;
                                  moveInDate?: ...;
                                  personId?: ...;
                                  postBox?: ...;
                                  stateRegion?: ...;
                                  street1?: ...;
                                  street2?: ...;
                                  streetName?: ...;
                                  structured?: ...;
                                  subDepartment?: ...;
                                  townLocationName?: ...;
                                  validityRange?: ...;
                                  zip?: ...;
                              }[]
                              | null;
                              creationDate?: string
                              | null;
                              documents?:
                                  | {
                                      docuId?: ...;
                                      documentTypeCode?: ...;
                                      expiryDate?: ...;
                                      issuingCountry?: ...;
                                      number?: ...;
                                      personId?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              forgotten?: boolean
                              | null;
                              fullName?: string | null;
                              home?: {
                                  buildingTypeCode?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                              };
                              identificationNumbers?: | {
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  idNumberId?: ...;
                                  personId?: ...;
                                  primary?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              legalForm?: string
                              | null;
                              mainPersonId?: string | null;
                              personalInfo?: {
                                  dependantPersons?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                              };
                              personGroupCodes?: | {
                                  personGroupCode: ...;
                                  personGroupId?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              personId?: string
                              | null;
                              relationships?:
                                  | {
                                      additionalData?: ...;
                                      beneficiary?: ...;
                                      parent?: ...;
                                      parentPersonId?: ...;
                                      percentageOfShares?: ...;
                                      percentageOfSignature?: ...;
                                      person?: ...;
                                      personId?: ...;
                                      personRelationshipId?: ...;
                                      relationTypeCode?: ...;
                                      representingRange?: ...;
                                      role?: ...;
                                      statusCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              source?: {
                                  sourceLink?: (...)
                                  | (...)
                                  | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              statusCode?: string
                              | null;
                              taxNumbers?:
                                  | {
                                      personId?: ...;
                                      primary?: ...;
                                      taxCountryCode?: ...;
                                      taxNumber?: ...;
                                      taxNumberId?: ...;
                                      taxNumberTypeCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              tenantCode?: string
                              | null;
                              work?: {
                                  activityCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create legal person

      Creates a new legal person

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    addresses?:
                        | {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            stateRegion?: string
                            | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[]
                        | null;
                    counterpartySectorCode?: string
                    | null;
                    identificationNumbers?:
                        | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                        | null;
                    name?: string | null;
                    registrationDate?: string | null;
                    taxNumbers?:
                        | {
                            primary?: boolean
                            | null;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode?:
                                | "TAX_IDENTIFICATION_NUMBER"
                                | "VAT_NUMBER"
                                | "NATIONAL_INSURANCE_NUMBER";
                        }[]
                        | null;
                    webAddress?: string
                    | null;
                };
                "application/json": {
                    addresses?: | {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        stateRegion?: string
                        | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[]
                    | null;
                    counterpartySectorCode?: string
                    | null;
                    identificationNumbers?:
                        | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                        | null;
                    name?: string | null;
                    registrationDate?: string | null;
                    taxNumbers?:
                        | {
                            primary?: boolean
                            | null;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode?:
                                | "TAX_IDENTIFICATION_NUMBER"
                                | "VAT_NUMBER"
                                | "NATIONAL_INSURANCE_NUMBER";
                        }[]
                        | null;
                    webAddress?: string
                    | null;
                };
                "text/json": {
                    addresses?: | {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        stateRegion?: string
                        | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[]
                    | null;
                    counterpartySectorCode?: string
                    | null;
                    identificationNumbers?:
                        | { idCountryCode: string; idNumber: string; primary?: boolean }[]
                        | null;
                    name?: string | null;
                    registrationDate?: string | null;
                    taxNumbers?:
                        | {
                            primary?: boolean
                            | null;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode?:
                                | "TAX_IDENTIFICATION_NUMBER"
                                | "VAT_NUMBER"
                                | "NATIONAL_INSURANCE_NUMBER";
                        }[]
                        | null;
                    webAddress?: string
                    | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            additionalContacts?:
                                | {
                                    additionalContactId?: ...;
                                    contactTypeCode?: ...;
                                    description?: ...;
                                    email?: ...;
                                    personId?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    preferredMethodOfContact?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            additionalInfo?: {
                                birthDate?: (...)
                                | (...)
                                | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            addresses?: | {
                                addressId?: ...;
                                addressTypeCode?: ...;
                                apartmentNumber?: ...;
                                buildingName?: ...;
                                buildingNumber?: ...;
                                cityCounty?: ...;
                                countryCode?: ...;
                                department?: ...;
                                district?: ...;
                                floor?: ...;
                                moveInDate?: ...;
                                personId?: ...;
                                postBox?: ...;
                                stateRegion?: ...;
                                street1?: ...;
                                street2?: ...;
                                streetName?: ...;
                                structured?: ...;
                                subDepartment?: ...;
                                townLocationName?: ...;
                                validityRange?: ...;
                                zip?: ...;
                            }[]
                            | null;
                            creationDate?: string
                            | null;
                            documents?:
                                | {
                                    docuId?: ...;
                                    documentTypeCode?: ...;
                                    expiryDate?: ...;
                                    issuingCountry?: ...;
                                    number?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            forgotten?: boolean
                            | null;
                            fullName?: string | null;
                            home?: {
                                buildingTypeCode?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                            };
                            identificationNumbers?: | {
                                idCountryCode?: ...;
                                idNumber?: ...;
                                idNumberId?: ...;
                                personId?: ...;
                                primary?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            legalForm?: string
                            | null;
                            mainPersonId?: string | null;
                            personalInfo?: {
                                dependantPersons?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                            };
                            personGroupCodes?: | {
                                personGroupCode: ...;
                                personGroupId?: ...;
                                personId?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            personId?: string
                            | null;
                            relationships?:
                                | {
                                    additionalData?: ...;
                                    beneficiary?: ...;
                                    parent?: ...;
                                    parentPersonId?: ...;
                                    percentageOfShares?: ...;
                                    percentageOfSignature?: ...;
                                    person?: ...;
                                    personId?: ...;
                                    personRelationshipId?: ...;
                                    relationTypeCode?: ...;
                                    representingRange?: ...;
                                    role?: ...;
                                    statusCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            source?: {
                                sourceLink?: (...)
                                | (...)
                                | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCode?: string
                            | null;
                            taxNumbers?:
                                | {
                                    personId?: ...;
                                    primary?: ...;
                                    taxCountryCode?: ...;
                                    taxNumber?: ...;
                                    taxNumberId?: ...;
                                    taxNumberTypeCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            tenantCode?: string
                            | null;
                            work?: {
                                activityCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          additionalContacts?:
                              | {
                                  additionalContactId?: ...;
                                  contactTypeCode?: ...;
                                  description?: ...;
                                  email?: ...;
                                  personId?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  preferredMethodOfContact?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          additionalInfo?: {
                              birthDate?: (...)
                              | (...)
                              | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          addresses?: | {
                              addressId?: ...;
                              addressTypeCode?: ...;
                              apartmentNumber?: ...;
                              buildingName?: ...;
                              buildingNumber?: ...;
                              cityCounty?: ...;
                              countryCode?: ...;
                              department?: ...;
                              district?: ...;
                              floor?: ...;
                              moveInDate?: ...;
                              personId?: ...;
                              postBox?: ...;
                              stateRegion?: ...;
                              street1?: ...;
                              street2?: ...;
                              streetName?: ...;
                              structured?: ...;
                              subDepartment?: ...;
                              townLocationName?: ...;
                              validityRange?: ...;
                              zip?: ...;
                          }[]
                          | null;
                          creationDate?: string
                          | null;
                          documents?:
                              | {
                                  docuId?: ...;
                                  documentTypeCode?: ...;
                                  expiryDate?: ...;
                                  issuingCountry?: ...;
                                  number?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          forgotten?: boolean
                          | null;
                          fullName?: string | null;
                          home?: {
                              buildingTypeCode?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                          };
                          identificationNumbers?: | {
                              idCountryCode?: ...;
                              idNumber?: ...;
                              idNumberId?: ...;
                              personId?: ...;
                              primary?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          legalForm?: string
                          | null;
                          mainPersonId?: string | null;
                          personalInfo?: {
                              dependantPersons?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                          };
                          personGroupCodes?: | {
                              personGroupCode: ...;
                              personGroupId?: ...;
                              personId?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          personId?: string
                          | null;
                          relationships?:
                              | {
                                  additionalData?: ...;
                                  beneficiary?: ...;
                                  parent?: ...;
                                  parentPersonId?: ...;
                                  percentageOfShares?: ...;
                                  percentageOfSignature?: ...;
                                  person?: ...;
                                  personId?: ...;
                                  personRelationshipId?: ...;
                                  relationTypeCode?: ...;
                                  representingRange?: ...;
                                  role?: ...;
                                  statusCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          source?: {
                              sourceLink?: (...)
                              | (...)
                              | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          statusCode?: string
                          | null;
                          taxNumbers?:
                              | {
                                  personId?: ...;
                                  primary?: ...;
                                  taxCountryCode?: ...;
                                  taxNumber?: ...;
                                  taxNumberId?: ...;
                                  taxNumberTypeCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          tenantCode?: string
                          | null;
                          work?: {
                              activityCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/api/zv1/persons/private": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "x-request-id": string; "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/*+json": {
                        addresses: {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[];
                        birthDate: string;
                        countryOfBirth: string;
                        email?: string
                        | null;
                        givenName: string;
                        identificationNumbers: {
                            expiryDate: string;
                            idCountryCode: string;
                            idNumber: string;
                            idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                            issuingDate?: string | null;
                            primary?: boolean;
                        }[];
                        middleName?: string
                        | null;
                        nationality: string;
                        pep: boolean;
                        pepExplanation?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        residencyCountryCode?: string | null;
                        sex: "M" | "F" | "O";
                        surname: string;
                        taxNumbers?:
                            | {
                                primary: boolean;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                                | "TAX_CODE"
                                | "SSN";
                            }[]
                            | null;
                        usResident?: boolean
                        | null;
                    };
                    "application/json": {
                        addresses: {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[];
                        birthDate: string;
                        countryOfBirth: string;
                        email?: string
                        | null;
                        givenName: string;
                        identificationNumbers: {
                            expiryDate: string;
                            idCountryCode: string;
                            idNumber: string;
                            idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                            issuingDate?: string | null;
                            primary?: boolean;
                        }[];
                        middleName?: string
                        | null;
                        nationality: string;
                        pep: boolean;
                        pepExplanation?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        residencyCountryCode?: string | null;
                        sex: "M" | "F" | "O";
                        surname: string;
                        taxNumbers?:
                            | {
                                primary: boolean;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                                | "TAX_CODE"
                                | "SSN";
                            }[]
                            | null;
                        usResident?: boolean
                        | null;
                    };
                    "text/json": {
                        addresses: {
                            addressTypeCode: | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                            cityCounty: string;
                            countryCode: string;
                            moveInDate?: string
                            | null;
                            stateRegion?: string | null;
                            street1: string;
                            street2?: string | null;
                            zip: string;
                        }[];
                        birthDate: string;
                        countryOfBirth: string;
                        email?: string
                        | null;
                        givenName: string;
                        identificationNumbers: {
                            expiryDate: string;
                            idCountryCode: string;
                            idNumber: string;
                            idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                            issuingDate?: string | null;
                            primary?: boolean;
                        }[];
                        middleName?: string
                        | null;
                        nationality: string;
                        pep: boolean;
                        pepExplanation?: string | null;
                        phoneCountryCode?: string | null;
                        phoneNumber?: string | null;
                        placeOfBirth?: string | null;
                        residencyCountryCode?: string | null;
                        sex: "M" | "F" | "O";
                        surname: string;
                        taxNumbers?:
                            | {
                                primary: boolean;
                                taxCountryCode: string;
                                taxNumber: string;
                                taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                                | "TAX_CODE"
                                | "SSN";
                            }[]
                            | null;
                        usResident?: boolean
                        | null;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data?: {
                                accessRestricted?: boolean
                                | null;
                                additionalContacts?:
                                    | {
                                        additionalContactId?: ...;
                                        contactTypeCode?: ...;
                                        description?: ...;
                                        email?: ...;
                                        personId?: ...;
                                        phoneCountryCode?: ...;
                                        phoneNumber?: ...;
                                        preferredMethodOfContact?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                additionalInfo?: {
                                    birthDate?: (...)
                                    | (...)
                                    | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    businessModelDescription?: (...) | (...) | (...);
                                    counterpartySectorCode?: (...) | (...) | (...);
                                    countryOfBirth?: (...) | (...) | (...);
                                    customerTypeCode?: (...) | (...) | (...);
                                    deathDate?: (...) | (...) | (...);
                                    dependantPersons?: (...) | (...) | (...);
                                    educationCode?: (...) | (...) | (...);
                                    inactivationDate?: (...) | (...) | (...);
                                    intraOrgCode?: (...) | (...) | (...);
                                    language?: (...) | (...) | (...);
                                    liquidationDate?: (...) | (...) | (...);
                                    mainPersonId?: (...) | (...) | (...);
                                    maritalStatusCode?: (...) | (...) | (...);
                                    pep?: (...) | (...) | (...) | (...);
                                    pepExplanation?: (...) | (...) | (...);
                                    placeOfBirth?: (...) | (...) | (...);
                                    registrationDate?: (...) | (...) | (...);
                                    statusCodeReason?: (...) | (...) | (...);
                                    taxResidencyCountry?: (...) | (...) | (...);
                                    tradingName?: (...) | (...) | (...);
                                    usResident?: (...) | (...) | (...) | (...);
                                    webAddress?: (...) | (...) | (...);
                                };
                                addresses?: | {
                                    addressId?: ...;
                                    addressTypeCode?: ...;
                                    apartmentNumber?: ...;
                                    buildingName?: ...;
                                    buildingNumber?: ...;
                                    cityCounty?: ...;
                                    countryCode?: ...;
                                    department?: ...;
                                    district?: ...;
                                    floor?: ...;
                                    moveInDate?: ...;
                                    personId?: ...;
                                    postBox?: ...;
                                    stateRegion?: ...;
                                    street1?: ...;
                                    street2?: ...;
                                    streetName?: ...;
                                    structured?: ...;
                                    subDepartment?: ...;
                                    townLocationName?: ...;
                                    validityRange?: ...;
                                    zip?: ...;
                                }[]
                                | null;
                                creationDate?: string
                                | null;
                                documents?:
                                    | {
                                        docuId?: ...;
                                        documentTypeCode?: ...;
                                        expiryDate?: ...;
                                        issuingCountry?: ...;
                                        number?: ...;
                                        personId?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                forgotten?: boolean
                                | null;
                                fullName?: string | null;
                                home?: {
                                    buildingTypeCode?: (...) | (...) | (...);
                                    housingTypeCode?: (...) | (...) | (...);
                                };
                                identificationNumbers?: | {
                                    idCountryCode?: ...;
                                    idNumber?: ...;
                                    idNumberId?: ...;
                                    personId?: ...;
                                    primary?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                legalForm?: string
                                | null;
                                mainPersonId?: string | null;
                                personalInfo?: {
                                    dependantPersons?: (...) | (...) | (...);
                                    email?: (...) | (...) | (...);
                                    givenName?: (...) | (...) | (...);
                                    legalForm?: (...) | (...) | (...);
                                    middleName?: (...) | (...) | (...);
                                    name?: (...) | (...) | (...);
                                    nationality?: (...) | (...) | (...);
                                    personTypeCode?: (...) | (...) | (...);
                                    phoneCountryCode?: (...) | (...) | (...);
                                    phoneNumber?: (...) | (...) | (...);
                                    residencyCountryCode?: (...) | (...) | (...);
                                    sex?: (...) | (...) | (...);
                                    surname?: (...) | (...) | (...);
                                };
                                personGroupCodes?: | {
                                    personGroupCode: ...;
                                    personGroupId?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                                personId?: string
                                | null;
                                relationships?:
                                    | {
                                        additionalData?: ...;
                                        beneficiary?: ...;
                                        parent?: ...;
                                        parentPersonId?: ...;
                                        percentageOfShares?: ...;
                                        percentageOfSignature?: ...;
                                        person?: ...;
                                        personId?: ...;
                                        personRelationshipId?: ...;
                                        relationTypeCode?: ...;
                                        representingRange?: ...;
                                        role?: ...;
                                        statusCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                source?: {
                                    sourceLink?: (...)
                                    | (...)
                                    | (...);
                                    sourceName: string;
                                    sourceRef: string;
                                };
                                statusCode?: string
                                | null;
                                taxNumbers?:
                                    | {
                                        personId?: ...;
                                        primary?: ...;
                                        taxCountryCode?: ...;
                                        taxNumber?: ...;
                                        taxNumberId?: ...;
                                        taxNumberTypeCode?: ...;
                                        validityRange?: ...;
                                    }[]
                                    | null;
                                tenantCode?: string
                                | null;
                                work?: {
                                    activityCode?: (...) | (...) | (...);
                                    businessAreaCodes?: (...) | (...) | (...);
                                    employmentTimeCode?: (...) | (...) | (...);
                                    fixedEmploymentLength?: (...) | (...) | (...);
                                };
                            };
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "x-request-id": string; "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/*+json": {
                      addresses: {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          moveInDate?: string
                          | null;
                          stateRegion?: string | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[];
                      birthDate: string;
                      countryOfBirth: string;
                      email?: string
                      | null;
                      givenName: string;
                      identificationNumbers: {
                          expiryDate: string;
                          idCountryCode: string;
                          idNumber: string;
                          idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                          issuingDate?: string | null;
                          primary?: boolean;
                      }[];
                      middleName?: string
                      | null;
                      nationality: string;
                      pep: boolean;
                      pepExplanation?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      residencyCountryCode?: string | null;
                      sex: "M" | "F" | "O";
                      surname: string;
                      taxNumbers?:
                          | {
                              primary: boolean;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                              | "TAX_CODE"
                              | "SSN";
                          }[]
                          | null;
                      usResident?: boolean
                      | null;
                  };
                  "application/json": {
                      addresses: {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          moveInDate?: string
                          | null;
                          stateRegion?: string | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[];
                      birthDate: string;
                      countryOfBirth: string;
                      email?: string
                      | null;
                      givenName: string;
                      identificationNumbers: {
                          expiryDate: string;
                          idCountryCode: string;
                          idNumber: string;
                          idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                          issuingDate?: string | null;
                          primary?: boolean;
                      }[];
                      middleName?: string
                      | null;
                      nationality: string;
                      pep: boolean;
                      pepExplanation?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      residencyCountryCode?: string | null;
                      sex: "M" | "F" | "O";
                      surname: string;
                      taxNumbers?:
                          | {
                              primary: boolean;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                              | "TAX_CODE"
                              | "SSN";
                          }[]
                          | null;
                      usResident?: boolean
                      | null;
                  };
                  "text/json": {
                      addresses: {
                          addressTypeCode: | "R"
                          | "C"
                          | "B"
                          | "D"
                          | "BILLING"
                          | "HQ_LOCATION"
                          | "PLACE_OF_BUSINESS"
                          | "SUBSIDIARY";
                          cityCounty: string;
                          countryCode: string;
                          moveInDate?: string
                          | null;
                          stateRegion?: string | null;
                          street1: string;
                          street2?: string | null;
                          zip: string;
                      }[];
                      birthDate: string;
                      countryOfBirth: string;
                      email?: string
                      | null;
                      givenName: string;
                      identificationNumbers: {
                          expiryDate: string;
                          idCountryCode: string;
                          idNumber: string;
                          idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                          issuingDate?: string | null;
                          primary?: boolean;
                      }[];
                      middleName?: string
                      | null;
                      nationality: string;
                      pep: boolean;
                      pepExplanation?: string | null;
                      phoneCountryCode?: string | null;
                      phoneNumber?: string | null;
                      placeOfBirth?: string | null;
                      residencyCountryCode?: string | null;
                      sex: "M" | "F" | "O";
                      surname: string;
                      taxNumbers?:
                          | {
                              primary: boolean;
                              taxCountryCode: string;
                              taxNumber: string;
                              taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                              | "TAX_CODE"
                              | "SSN";
                          }[]
                          | null;
                      usResident?: boolean
                      | null;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data?: {
                              accessRestricted?: boolean
                              | null;
                              additionalContacts?:
                                  | {
                                      additionalContactId?: ...;
                                      contactTypeCode?: ...;
                                      description?: ...;
                                      email?: ...;
                                      personId?: ...;
                                      phoneCountryCode?: ...;
                                      phoneNumber?: ...;
                                      preferredMethodOfContact?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              additionalInfo?: {
                                  birthDate?: (...)
                                  | (...)
                                  | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  businessModelDescription?: (...) | (...) | (...);
                                  counterpartySectorCode?: (...) | (...) | (...);
                                  countryOfBirth?: (...) | (...) | (...);
                                  customerTypeCode?: (...) | (...) | (...);
                                  deathDate?: (...) | (...) | (...);
                                  dependantPersons?: (...) | (...) | (...);
                                  educationCode?: (...) | (...) | (...);
                                  inactivationDate?: (...) | (...) | (...);
                                  intraOrgCode?: (...) | (...) | (...);
                                  language?: (...) | (...) | (...);
                                  liquidationDate?: (...) | (...) | (...);
                                  mainPersonId?: (...) | (...) | (...);
                                  maritalStatusCode?: (...) | (...) | (...);
                                  pep?: (...) | (...) | (...) | (...);
                                  pepExplanation?: (...) | (...) | (...);
                                  placeOfBirth?: (...) | (...) | (...);
                                  registrationDate?: (...) | (...) | (...);
                                  statusCodeReason?: (...) | (...) | (...);
                                  taxResidencyCountry?: (...) | (...) | (...);
                                  tradingName?: (...) | (...) | (...);
                                  usResident?: (...) | (...) | (...) | (...);
                                  webAddress?: (...) | (...) | (...);
                              };
                              addresses?: | {
                                  addressId?: ...;
                                  addressTypeCode?: ...;
                                  apartmentNumber?: ...;
                                  buildingName?: ...;
                                  buildingNumber?: ...;
                                  cityCounty?: ...;
                                  countryCode?: ...;
                                  department?: ...;
                                  district?: ...;
                                  floor?: ...;
                                  moveInDate?: ...;
                                  personId?: ...;
                                  postBox?: ...;
                                  stateRegion?: ...;
                                  street1?: ...;
                                  street2?: ...;
                                  streetName?: ...;
                                  structured?: ...;
                                  subDepartment?: ...;
                                  townLocationName?: ...;
                                  validityRange?: ...;
                                  zip?: ...;
                              }[]
                              | null;
                              creationDate?: string
                              | null;
                              documents?:
                                  | {
                                      docuId?: ...;
                                      documentTypeCode?: ...;
                                      expiryDate?: ...;
                                      issuingCountry?: ...;
                                      number?: ...;
                                      personId?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              forgotten?: boolean
                              | null;
                              fullName?: string | null;
                              home?: {
                                  buildingTypeCode?: (...) | (...) | (...);
                                  housingTypeCode?: (...) | (...) | (...);
                              };
                              identificationNumbers?: | {
                                  idCountryCode?: ...;
                                  idNumber?: ...;
                                  idNumberId?: ...;
                                  personId?: ...;
                                  primary?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              legalForm?: string
                              | null;
                              mainPersonId?: string | null;
                              personalInfo?: {
                                  dependantPersons?: (...) | (...) | (...);
                                  email?: (...) | (...) | (...);
                                  givenName?: (...) | (...) | (...);
                                  legalForm?: (...) | (...) | (...);
                                  middleName?: (...) | (...) | (...);
                                  name?: (...) | (...) | (...);
                                  nationality?: (...) | (...) | (...);
                                  personTypeCode?: (...) | (...) | (...);
                                  phoneCountryCode?: (...) | (...) | (...);
                                  phoneNumber?: (...) | (...) | (...);
                                  residencyCountryCode?: (...) | (...) | (...);
                                  sex?: (...) | (...) | (...);
                                  surname?: (...) | (...) | (...);
                              };
                              personGroupCodes?: | {
                                  personGroupCode: ...;
                                  personGroupId?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                              personId?: string
                              | null;
                              relationships?:
                                  | {
                                      additionalData?: ...;
                                      beneficiary?: ...;
                                      parent?: ...;
                                      parentPersonId?: ...;
                                      percentageOfShares?: ...;
                                      percentageOfSignature?: ...;
                                      person?: ...;
                                      personId?: ...;
                                      personRelationshipId?: ...;
                                      relationTypeCode?: ...;
                                      representingRange?: ...;
                                      role?: ...;
                                      statusCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              source?: {
                                  sourceLink?: (...)
                                  | (...)
                                  | (...);
                                  sourceName: string;
                                  sourceRef: string;
                              };
                              statusCode?: string
                              | null;
                              taxNumbers?:
                                  | {
                                      personId?: ...;
                                      primary?: ...;
                                      taxCountryCode?: ...;
                                      taxNumber?: ...;
                                      taxNumberId?: ...;
                                      taxNumberTypeCode?: ...;
                                      validityRange?: ...;
                                  }[]
                                  | null;
                              tenantCode?: string
                              | null;
                              work?: {
                                  activityCode?: (...) | (...) | (...);
                                  businessAreaCodes?: (...) | (...) | (...);
                                  employmentTimeCode?: (...) | (...) | (...);
                                  fixedEmploymentLength?: (...) | (...) | (...);
                              };
                          };
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Create private person

      Creates a new private person

      • parameters: {
            cookie?: undefined;
            header: { "x-request-id": string; "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "x-request-id": string; "x-tenant-id"?: string }
          • x-request-id: string
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/*+json": {
                    addresses: {
                        addressTypeCode:
                            | "R"
                            | "C"
                            | "B"
                            | "D"
                            | "BILLING"
                            | "HQ_LOCATION"
                            | "PLACE_OF_BUSINESS"
                            | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[];
                    birthDate: string;
                    countryOfBirth: string;
                    email?: string
                    | null;
                    givenName: string;
                    identificationNumbers: {
                        expiryDate: string;
                        idCountryCode: string;
                        idNumber: string;
                        idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                        issuingDate?: string | null;
                        primary?: boolean;
                    }[];
                    middleName?: string
                    | null;
                    nationality: string;
                    pep: boolean;
                    pepExplanation?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    residencyCountryCode?: string | null;
                    sex: "M" | "F" | "O";
                    surname: string;
                    taxNumbers?:
                        | {
                            primary: boolean;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                            | "TAX_CODE"
                            | "SSN";
                        }[]
                        | null;
                    usResident?: boolean
                    | null;
                };
                "application/json": {
                    addresses: {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[];
                    birthDate: string;
                    countryOfBirth: string;
                    email?: string
                    | null;
                    givenName: string;
                    identificationNumbers: {
                        expiryDate: string;
                        idCountryCode: string;
                        idNumber: string;
                        idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                        issuingDate?: string | null;
                        primary?: boolean;
                    }[];
                    middleName?: string
                    | null;
                    nationality: string;
                    pep: boolean;
                    pepExplanation?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    residencyCountryCode?: string | null;
                    sex: "M" | "F" | "O";
                    surname: string;
                    taxNumbers?:
                        | {
                            primary: boolean;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                            | "TAX_CODE"
                            | "SSN";
                        }[]
                        | null;
                    usResident?: boolean
                    | null;
                };
                "text/json": {
                    addresses: {
                        addressTypeCode: | "R"
                        | "C"
                        | "B"
                        | "D"
                        | "BILLING"
                        | "HQ_LOCATION"
                        | "PLACE_OF_BUSINESS"
                        | "SUBSIDIARY";
                        cityCounty: string;
                        countryCode: string;
                        moveInDate?: string
                        | null;
                        stateRegion?: string | null;
                        street1: string;
                        street2?: string | null;
                        zip: string;
                    }[];
                    birthDate: string;
                    countryOfBirth: string;
                    email?: string
                    | null;
                    givenName: string;
                    identificationNumbers: {
                        expiryDate: string;
                        idCountryCode: string;
                        idNumber: string;
                        idTypeCode: "PASSPORT" | "DRIVER_LICENCE" | "ID_CARD";
                        issuingDate?: string | null;
                        primary?: boolean;
                    }[];
                    middleName?: string
                    | null;
                    nationality: string;
                    pep: boolean;
                    pepExplanation?: string | null;
                    phoneCountryCode?: string | null;
                    phoneNumber?: string | null;
                    placeOfBirth?: string | null;
                    residencyCountryCode?: string | null;
                    sex: "M" | "F" | "O";
                    surname: string;
                    taxNumbers?:
                        | {
                            primary: boolean;
                            taxCountryCode: string;
                            taxNumber: string;
                            taxNumberTypeCode: "NATIONAL_INSURANCE_NUMBER"
                            | "TAX_CODE"
                            | "SSN";
                        }[]
                        | null;
                    usResident?: boolean
                    | null;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data?: {
                            accessRestricted?: boolean | null;
                            additionalContacts?:
                                | {
                                    additionalContactId?: ...;
                                    contactTypeCode?: ...;
                                    description?: ...;
                                    email?: ...;
                                    personId?: ...;
                                    phoneCountryCode?: ...;
                                    phoneNumber?: ...;
                                    preferredMethodOfContact?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            additionalInfo?: {
                                birthDate?: (...)
                                | (...)
                                | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                businessModelDescription?: (...) | (...) | (...);
                                counterpartySectorCode?: (...) | (...) | (...);
                                countryOfBirth?: (...) | (...) | (...);
                                customerTypeCode?: (...) | (...) | (...);
                                deathDate?: (...) | (...) | (...);
                                dependantPersons?: (...) | (...) | (...);
                                educationCode?: (...) | (...) | (...);
                                inactivationDate?: (...) | (...) | (...);
                                intraOrgCode?: (...) | (...) | (...);
                                language?: (...) | (...) | (...);
                                liquidationDate?: (...) | (...) | (...);
                                mainPersonId?: (...) | (...) | (...);
                                maritalStatusCode?: (...) | (...) | (...);
                                pep?: (...) | (...) | (...) | (...);
                                pepExplanation?: (...) | (...) | (...);
                                placeOfBirth?: (...) | (...) | (...);
                                registrationDate?: (...) | (...) | (...);
                                statusCodeReason?: (...) | (...) | (...);
                                taxResidencyCountry?: (...) | (...) | (...);
                                tradingName?: (...) | (...) | (...);
                                usResident?: (...) | (...) | (...) | (...);
                                webAddress?: (...) | (...) | (...);
                            };
                            addresses?: | {
                                addressId?: ...;
                                addressTypeCode?: ...;
                                apartmentNumber?: ...;
                                buildingName?: ...;
                                buildingNumber?: ...;
                                cityCounty?: ...;
                                countryCode?: ...;
                                department?: ...;
                                district?: ...;
                                floor?: ...;
                                moveInDate?: ...;
                                personId?: ...;
                                postBox?: ...;
                                stateRegion?: ...;
                                street1?: ...;
                                street2?: ...;
                                streetName?: ...;
                                structured?: ...;
                                subDepartment?: ...;
                                townLocationName?: ...;
                                validityRange?: ...;
                                zip?: ...;
                            }[]
                            | null;
                            creationDate?: string
                            | null;
                            documents?:
                                | {
                                    docuId?: ...;
                                    documentTypeCode?: ...;
                                    expiryDate?: ...;
                                    issuingCountry?: ...;
                                    number?: ...;
                                    personId?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            forgotten?: boolean
                            | null;
                            fullName?: string | null;
                            home?: {
                                buildingTypeCode?: (...) | (...) | (...);
                                housingTypeCode?: (...) | (...) | (...);
                            };
                            identificationNumbers?: | {
                                idCountryCode?: ...;
                                idNumber?: ...;
                                idNumberId?: ...;
                                personId?: ...;
                                primary?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            legalForm?: string
                            | null;
                            mainPersonId?: string | null;
                            personalInfo?: {
                                dependantPersons?: (...) | (...) | (...);
                                email?: (...) | (...) | (...);
                                givenName?: (...) | (...) | (...);
                                legalForm?: (...) | (...) | (...);
                                middleName?: (...) | (...) | (...);
                                name?: (...) | (...) | (...);
                                nationality?: (...) | (...) | (...);
                                personTypeCode?: (...) | (...) | (...);
                                phoneCountryCode?: (...) | (...) | (...);
                                phoneNumber?: (...) | (...) | (...);
                                residencyCountryCode?: (...) | (...) | (...);
                                sex?: (...) | (...) | (...);
                                surname?: (...) | (...) | (...);
                            };
                            personGroupCodes?: | {
                                personGroupCode: ...;
                                personGroupId?: ...;
                                personId?: ...;
                                validityRange?: ...;
                            }[]
                            | null;
                            personId?: string
                            | null;
                            relationships?:
                                | {
                                    additionalData?: ...;
                                    beneficiary?: ...;
                                    parent?: ...;
                                    parentPersonId?: ...;
                                    percentageOfShares?: ...;
                                    percentageOfSignature?: ...;
                                    person?: ...;
                                    personId?: ...;
                                    personRelationshipId?: ...;
                                    relationTypeCode?: ...;
                                    representingRange?: ...;
                                    role?: ...;
                                    statusCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            source?: {
                                sourceLink?: (...)
                                | (...)
                                | (...);
                                sourceName: string;
                                sourceRef: string;
                            };
                            statusCode?: string
                            | null;
                            taxNumbers?:
                                | {
                                    personId?: ...;
                                    primary?: ...;
                                    taxCountryCode?: ...;
                                    taxNumber?: ...;
                                    taxNumberId?: ...;
                                    taxNumberTypeCode?: ...;
                                    validityRange?: ...;
                                }[]
                                | null;
                            tenantCode?: string
                            | null;
                            work?: {
                                activityCode?: (...) | (...) | (...);
                                businessAreaCodes?: (...) | (...) | (...);
                                employmentTimeCode?: (...) | (...) | (...);
                                fixedEmploymentLength?: (...) | (...) | (...);
                            };
                        };
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data?: {
                          accessRestricted?: boolean | null;
                          additionalContacts?:
                              | {
                                  additionalContactId?: ...;
                                  contactTypeCode?: ...;
                                  description?: ...;
                                  email?: ...;
                                  personId?: ...;
                                  phoneCountryCode?: ...;
                                  phoneNumber?: ...;
                                  preferredMethodOfContact?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          additionalInfo?: {
                              birthDate?: (...)
                              | (...)
                              | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              businessModelDescription?: (...) | (...) | (...);
                              counterpartySectorCode?: (...) | (...) | (...);
                              countryOfBirth?: (...) | (...) | (...);
                              customerTypeCode?: (...) | (...) | (...);
                              deathDate?: (...) | (...) | (...);
                              dependantPersons?: (...) | (...) | (...);
                              educationCode?: (...) | (...) | (...);
                              inactivationDate?: (...) | (...) | (...);
                              intraOrgCode?: (...) | (...) | (...);
                              language?: (...) | (...) | (...);
                              liquidationDate?: (...) | (...) | (...);
                              mainPersonId?: (...) | (...) | (...);
                              maritalStatusCode?: (...) | (...) | (...);
                              pep?: (...) | (...) | (...) | (...);
                              pepExplanation?: (...) | (...) | (...);
                              placeOfBirth?: (...) | (...) | (...);
                              registrationDate?: (...) | (...) | (...);
                              statusCodeReason?: (...) | (...) | (...);
                              taxResidencyCountry?: (...) | (...) | (...);
                              tradingName?: (...) | (...) | (...);
                              usResident?: (...) | (...) | (...) | (...);
                              webAddress?: (...) | (...) | (...);
                          };
                          addresses?: | {
                              addressId?: ...;
                              addressTypeCode?: ...;
                              apartmentNumber?: ...;
                              buildingName?: ...;
                              buildingNumber?: ...;
                              cityCounty?: ...;
                              countryCode?: ...;
                              department?: ...;
                              district?: ...;
                              floor?: ...;
                              moveInDate?: ...;
                              personId?: ...;
                              postBox?: ...;
                              stateRegion?: ...;
                              street1?: ...;
                              street2?: ...;
                              streetName?: ...;
                              structured?: ...;
                              subDepartment?: ...;
                              townLocationName?: ...;
                              validityRange?: ...;
                              zip?: ...;
                          }[]
                          | null;
                          creationDate?: string
                          | null;
                          documents?:
                              | {
                                  docuId?: ...;
                                  documentTypeCode?: ...;
                                  expiryDate?: ...;
                                  issuingCountry?: ...;
                                  number?: ...;
                                  personId?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          forgotten?: boolean
                          | null;
                          fullName?: string | null;
                          home?: {
                              buildingTypeCode?: (...) | (...) | (...);
                              housingTypeCode?: (...) | (...) | (...);
                          };
                          identificationNumbers?: | {
                              idCountryCode?: ...;
                              idNumber?: ...;
                              idNumberId?: ...;
                              personId?: ...;
                              primary?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          legalForm?: string
                          | null;
                          mainPersonId?: string | null;
                          personalInfo?: {
                              dependantPersons?: (...) | (...) | (...);
                              email?: (...) | (...) | (...);
                              givenName?: (...) | (...) | (...);
                              legalForm?: (...) | (...) | (...);
                              middleName?: (...) | (...) | (...);
                              name?: (...) | (...) | (...);
                              nationality?: (...) | (...) | (...);
                              personTypeCode?: (...) | (...) | (...);
                              phoneCountryCode?: (...) | (...) | (...);
                              phoneNumber?: (...) | (...) | (...);
                              residencyCountryCode?: (...) | (...) | (...);
                              sex?: (...) | (...) | (...);
                              surname?: (...) | (...) | (...);
                          };
                          personGroupCodes?: | {
                              personGroupCode: ...;
                              personGroupId?: ...;
                              personId?: ...;
                              validityRange?: ...;
                          }[]
                          | null;
                          personId?: string
                          | null;
                          relationships?:
                              | {
                                  additionalData?: ...;
                                  beneficiary?: ...;
                                  parent?: ...;
                                  parentPersonId?: ...;
                                  percentageOfShares?: ...;
                                  percentageOfSignature?: ...;
                                  person?: ...;
                                  personId?: ...;
                                  personRelationshipId?: ...;
                                  relationTypeCode?: ...;
                                  representingRange?: ...;
                                  role?: ...;
                                  statusCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          source?: {
                              sourceLink?: (...)
                              | (...)
                              | (...);
                              sourceName: string;
                              sourceRef: string;
                          };
                          statusCode?: string
                          | null;
                          taxNumbers?:
                              | {
                                  personId?: ...;
                                  primary?: ...;
                                  taxCountryCode?: ...;
                                  taxNumber?: ...;
                                  taxNumberId?: ...;
                                  taxNumberTypeCode?: ...;
                                  validityRange?: ...;
                              }[]
                              | null;
                          tenantCode?: string
                          | null;
                          work?: {
                              activityCode?: (...) | (...) | (...);
                              businessAreaCodes?: (...) | (...) | (...);
                              employmentTimeCode?: (...) | (...) | (...);
                              fixedEmploymentLength?: (...) | (...) | (...);
                          };
                      };
                      errors?: string[]
                      | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 403: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/login/oauth2/v2.0/token": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: { "x-tenant-id"?: string };
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/x-www-form-urlencoded": {
                        client_id?: string;
                        client_secret?: string;
                        grant_type?: string;
                        scope?: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            access_token?: string;
                            expires_in?: number;
                            ext_expires_in?: number;
                            token_type?: string
                            | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            correlation_id?: string
                            | null;
                            error?: string | null;
                            error_codes?: number[] | null;
                            error_description?: string | null;
                            error_uri?: string | null;
                            timestamp?: string | null;
                            trace_id?: string | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            errors?: string[]
                            | null;
                            validationErrors?:
                                | { errors?: (...)[]
                                | null; field?: string | null }[]
                                | null;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: { "x-tenant-id"?: string };
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/x-www-form-urlencoded": {
                      client_id?: string;
                      client_secret?: string;
                      grant_type?: string;
                      scope?: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          access_token?: string;
                          expires_in?: number;
                          ext_expires_in?: number;
                          token_type?: string
                          | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          correlation_id?: string
                          | null;
                          error?: string | null;
                          error_codes?: number[] | null;
                          error_description?: string | null;
                          error_uri?: string | null;
                          timestamp?: string | null;
                          trace_id?: string | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          errors?: string[]
                          | null;
                          validationErrors?:
                              | { errors?: (...)[]
                              | null; field?: string | null }[]
                              | null;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get new access token

      Get new access token

      • parameters: {
            cookie?: undefined;
            header?: { "x-tenant-id"?: string };
            path?: undefined;
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: { "x-tenant-id"?: string }
          • Optionalx-tenant-id?: string

            Optional header that specifies the tenant context for the request

        • Optionalpath?: undefined
        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/x-www-form-urlencoded": {
                    client_id?: string;
                    client_secret?: string;
                    grant_type?: string;
                    scope?: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        access_token?: string;
                        expires_in?: number;
                        ext_expires_in?: number;
                        token_type?: string | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        correlation_id?: string
                        | null;
                        error?: string | null;
                        error_codes?: number[] | null;
                        error_description?: string | null;
                        error_uri?: string | null;
                        timestamp?: string | null;
                        trace_id?: string | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        errors?: string[]
                        | null;
                        validationErrors?:
                            | { errors?: (...)[]
                            | null; field?: string | null }[]
                            | null;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      access_token?: string;
                      expires_in?: number;
                      ext_expires_in?: number;
                      token_type?: string | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          OK

        • 400: {
              content: {
                  "application/json": {
                      correlation_id?: string | null;
                      error?: string | null;
                      error_codes?: number[] | null;
                      error_description?: string | null;
                      error_uri?: string | null;
                      timestamp?: string | null;
                      trace_id?: string | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 404: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Resouce Not Found

        • 500: {
              content: {
                  "application/json": {
                      errors?: string[] | null;
                      validationErrors?:
                          | { errors?: (...)[]
                          | null; field?: string | null }[]
                          | null;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined