#PaginatedResponseEntreeEnRelationDto

Response payload containing the actual data

data object[]

Array [

idstring

Unique identifier

Example: 550e8400-e29b-41d4-a716-446655440000

documentIDTypestring

Official identification document type code that classifies the form of ID

Example: 00012

documentIDNumberstring

Official identification document number as it appears on the ID

Example: 550e8400-e29b-41d4-a716-446655440000

issueDateIDstring

Date when the ID document was issued, in DD-MM-YYYY format

Possible values: Value must match regular expression dd-MM-yyyy

Example: 24-08-2023

emissionDateIDFormattedstring<date-time>

ISO formatted timestamp of ID document's issue date

Example: 2023-08-23T22:00:00Z

expirationDateIDstring

Date when the ID document expires, in DD-MM-YYYY format

Possible values: Value must match regular expression dd-MM-yyyy

Example: 03-09-2023

expirationDateIDFormattedstring<date-time>

ISO formatted timestamp of ID document's expiration date

Example: 2023-09-02T22:00:00Z

subscriberTitlestring

The codification of the subscriber's title

Example: 06

lastNamestring

Subscriber's family name/surname

Possible values: non-empty and <= 100 characters

Example: Ibrahimi

firstNamestring

Subscriber's given name

Possible values: non-empty and <= 100 characters

Example: Mohammed

phoneNumberstring

Subscriber's phone number

Example: 0612890678

phoneCountryCodestring

Phone country code

Default value: +212

Example: +212

isEmployedboolean

Employment status of the client

Example: true

employerNamestring

Legal name of the client's employer

Possible values: <= 100 characters

Example: Adria Corporation

revenueAmountstring

Annual income amount in base currency units

Possible values: >= 0

Example: 150032

professionstring

Client's professional occupation category code

Example: 210

professionalAmountnumber

Professional annual income in base currency units

Possible values: >= 0

Example: 75000

primaryEmailstring<email>

Primary email address used for communications

Example: samir.mouaalim@yahoo.com

activityDomainstring

Business sector or industry classification code

Example: 0007

maritalStatusstring

Client's marital status code

Example: 2

childrenNumberinteger<int32>

Number of dependent children

Possible values: >= 0 and <= 20

Example: 2

motherNamestring

Full legal name of client's mother

Possible values: <= 100 characters

Example: Sara Mouttaa

birthDatestring

Client's date of birth in DD-MM-YYYY format

Possible values: Value must match regular expression dd-MM-yyyy

Example: 24-08-1991

birthDateFormattedstring<date-time>

ISO formatted timestamp of client's birth date

Example: 2005-08-23T22:00:00Z

birthPlacestring

Country or city of birth

Possible values: <= 50 characters

Example: MAROC

residencePlacestring

Current country of residence

Possible values: <= 50 characters

Example: MAROC

headquartersAddressstring

Complete business headquarters street address

Possible values: <= 200 characters

Example: 123 Business Street

isUsTaxPayerboolean

Is US taxpayer

Example: false

segmentstring

Activity segment

Example: P_SegmentClientContrat

hasWalletSubscriptionboolean

This is set to true if the client has a wallet subscription otherwise it is set to false

Example: true

eBankingSubscriptionboolean

This is set to true if the client has a e-banking subscription otherwise it is set to false

Example: true

statusstring

The status of the client

Example: ACTIVE

isEBankingActivatedboolean

Is e-banking activated

Example: true

bankCodestring

Bank code

Example: 00010

contractIdstring

Contract identifier

Example: 3905

userIdstring

User ID

Example: 2c9180878e66bd67018e6d6a6da90000

attachmentDescriptionstring

Attachment description

Example: Passport scan

walletLevelstring

Wallet level

Example: 2

citystring

City the client is in

Example: CASABLANCA

countrystring

The country the client is in

Example: USA

postalCodestring

Postal code

Example: 43000

emailstring

Email

Example: ibramini.mohammed@email.com

onboardingDatestring

Onboarding date

Example: 2024-01-01

productTypestring

Product type

Example: SAVINGS_ACCOUNT

filesstring<binary>[]

Files in multipart format

signaturestring<binary>

upgradeIdstring

Upgrade ID

Example: 789

currentTypestring

Current type

Example: STANDARD

targetTypestring

Target type

Example: PREMIUM

upgradeStatusstring

Upgrade status

Example: PENDING

upgradeDatestring<date-time>

Upgrade date

Example: 2024-02-01T00:00:00Z

upgradeDateFormattedstring

Formatted upgrade date

Example: 2024-02-01

rejectionReasonstring

Rejection reason

Example: INCOMPLETE_DOCUMENTATION

currentAccountTypestring

Current account type

Example: INDIVIDUAL

idDocumentTypeLabelstring

ID document type label

Example: Passport

subscriberTitleLabelstring

Subscriber title label

Example: M

professionLabelstring

Profession label

Example: Software Engineer

activityDomainLabelstring

Activity domain label

Example: Information Technology

maritalStatusLabelstring

Marital status label

Example: Married

birthPlaceLabelstring

Birth place label

Example: New York City

residencePlaceLabelstring

Residence place label

Example: Manhattan, NY

segmentLabelstring

Segment label

Example: Premium Customer

customerTypestring

Customer type

Example: INDIVIDUAL

languagestring

Language

Example: fr

nationalityCodestring

Nationality code

Example: USA

middleNamestring

Middle name

Example: ROBERT

genderstring

Gender

Example: M

birthCountrystring

Country of birth

Example: USA

idPaperDeliveryPlacestring

ID paper delivery place

Example: NKTT

issuingOrganizationstring

Issuing organization

Example: US STATE DEPARTMENT

nationalIdentifierstring

National identifier

Example: 123-45-6789

birthCitystring

City of birth

Example: CASABLANCA

territorialityCodestring

Territoriality code

Example: US-NY

branchCodestring

Branch code

Example: NYC001

countryCodestring

Country code

Example: USA

customerOfficerstring

Customer officer

Example: AGENT123

qualityCodestring

Quality code

Example: A1

taxableCustomerstring

Taxable customer

Example: YES

freeAttributes object[]

Free attributes

Array [

customerCodestringrequired

Customer unique identifier code

Example: CUST123

additionalData objectrequired

DTO containing additional data information

identifierstringrequired

Unique identifier for the additional data

Example: DATA_001

value objectrequired

DTO representing different types of additional data values

alphanumericstring

Alphanumeric value

Example: ABC123

amountOrRatenumber

Amount or rate value

Example: 1234.56

datestring

Date value in format (dd-MM-yyyy)

Possible values: Value must match regular expression ^\d{2}-\d{2}-\d{4}$

Example: 31-12-2024

freeTextstring

Free text field for additional customer information

Possible values: <= 500 characters

Example: Special customer requirements

]

declaredHomestring

Declared home

Example: OWNED

economicAgentCodestring

Economic agent code

Example: EAC123

customerActivityFieldCodestring

Customer activity field code

Example: IT_SERVICES

bankRelationshipstring

Bank relationship

Example: PRIMARY

addresses object[]

Addresses

Array [

typestringrequired

Type of address (e.g., HOME, WORK, BILLING)

Example: HOME

languageCodestringrequired

Language code (ISO 639-1)

Example: fr

addressFormatstring

Format of the address

Example: STANDARD

addressLine1stringrequired

Primary address line

Example: 123 Rue Mohammed V

addressLine2string

Secondary address line

Example: Appartement 4B

addressLine3string

Additional address line

Example: Quartier des Affaires

citystringrequired

City name

Example: Casablanca

countryCodestringrequired

Country code

Example: MA

branchCodestringrequired

Branch code

Example: 00004

geographicalDepartmentstring

Geographical department code

Example: CAS

]

phoneNumbers object[]

Phone numbers

Array [

identifier objectrequired

Identifier information for creating a phone number

customerCodestringrequired

The unique code identifying the customer

Example: CUST123

typestringrequired

The type of phone number (e.g., MOBILE, HOME, WORK)

Example: MOBILE

phoneNumberstringrequired

The phone number to be created

Example: +1-555-123-4567

formatstringrequired

The format specification for the phone number

Example: E164

]

professionsAndIncomes object[]

Profession and income details

Array [

hireDatestring

Date when the customer was hired by their employer

Example: 15-01-2024

professionCodestring

Code representing the customer's profession

Example: ENG001

employerCodestring

Unique identifier code for the employer

Example: EMP123

incomesBracketCodestring

Code representing the customer's income bracket

Example: IB500K

employerDepartmentstring

Department within the employer organization where the customer works

Example: IT Department

]

pmlDefaultstring

PML default

Example: LOW_RISK

profileCodestring

Profile code

Example: PRF001

accountCreation object

DTO for creating a new bank account with all necessary configurations

productCodestring

Product code identifying the type of account

Example: SAV001

accountClassCodestring

Code defining the account classification

Example: PERSONAL

accountTypestring

Type of account (e.g., Savings, Checking)

Example: SAVINGS

taxableAccountstring

Indicates if the account is subject to taxation

Example: Y

accountSubjectToInterestCalculationstring

Indicates if interest calculations apply to this account

Example: Y

frequencyOfDebitInterestCalculationstring

Frequency of calculating debit interest

Example: MONTHLY

frequencyOfCreditInterestCalculationstring

Frequency of calculating credit interest

Example: MONTHLY

codeForInterestLadderPrintingstring

Code specifying how interest ladder should be printed

Example: STD

accountSubjectToDeductionAtSourcestring

Indicates if the account is subject to source deduction

Example: Y

maturityDatestring<date>

Account maturity date for term deposits

Example: 2025-12-31

serviceCodestring

Code for additional services attached to the account

Example: PREMIUM

accountStatementCodestring

Code defining the type of account statement

Example: MONTHLY

accountStatementDeliveryMethodstring

Method of delivering account statements

Example: EMAIL

thresholdForReorderingChequesstring

Minimum number of cheques that triggers reordering

Example: 5

defaultChequeBookTypestring

Default type of cheque book for this account

Example: STD25

chequeDeliveryMethodstring

Method of delivering cheque books

Example: BRANCH

branchThatDeliveredTheChequeBookstring

Branch code responsible for cheque book delivery

Example: BR001

agenceDigitalstring

Digital agency identifier

Example: DIG001

documents object[]

Documents

Array [

id_countrystring

Country code where the ID was issued

Example: MA

id_expirystring

Expiry date of the identification document

Example: 31-12-2025

id_numberstring

Identification document number

Example: AB123456

id_typestring

Type of identification document

Example: PASSPORT

referencestring

Unique reference for the document

Example: DOC-2023-001

radicalstring

Root identifier for document classification

Example: CLI

documentNatureCodestring

Code indicating the nature/type of document

Example: CONT001

documentNamestring

Name of the document

Example: Contract Agreement

confidentialstring

Indicates if the document is confidential

Example: Y

filestring

File name or path

Example: contract_12345.pdf

fileBytesstring<byte>

codeBanquestring

Bank code identifier

Example: BNK001

]

functionstring

Function

Example: EMPLOYEE

offerTypestring

Offer type

Example: PREMIUM_PACKAGE

documentIDstring

ID document

Example: passport.pdf

photostring

Photo

Example: profile.jpg

addressProofstring

Address proof

Example: utility_bill.pdf

incomeProofstring

Income proof

Example: payslip.pdf

agencystring

Agency

Example: 00020

otherstring

Other

Example: Additional notes

commercialOffersstring[]

Commercial offers

Example: ["193"]

professionalProfilesstring[]

Professional profiles

Example: ["TRADE_FINANCE_CAUTION_BO","TRADE_FINANCE_GUARANTEE_BO","BO_CREATEUR_VALIDATEUR"]

languageCodestring

Enumeration of supported language codes by Adria standard

Possible values: [EN, FR, ES, DE, IT, PT, AR]

Example: EN

filesContent object[]

Files content

Array [

fileNamestring

Name of the file

Example: document.pdf

fileContentstring

Content of the file as string

Example: base64_encoded_content

fileTypestring

Type/extension of the file

Example: pdf

radicalstring

Root identifier for file classification

Example: CLI

codeBanquestring

Bank code identifier

Example: 00014

]

hireDatestring

Hire date

Example: 23-08-2023

accountNumberstring

Account number

Example: 1234567890

statusLabelstring

Status label

Example: Active Account

requestIdstring

Request identifier

Example: EER00085C_ADRIA

incomeBracketCodestring

Income bracket code

Example: B3

]

totalinteger<int64>

pageinteger<int32>

sizeinteger<int32>

totalPagesinteger<int64>

PaginatedResponseEntreeEnRelationDto

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "documentIDType": "00012",
      "documentIDNumber": "550e8400-e29b-41d4-a716-446655440000",
      "issueDateID": "24-08-2023",
      "emissionDateIDFormatted": "2023-08-23T22:00:00Z",
      "expirationDateID": "03-09-2023",
      "expirationDateIDFormatted": "2023-09-02T22:00:00Z",
      "subscriberTitle": "06",
      "lastName": "Ibrahimi",
      "firstName": "Mohammed",
      "phoneNumber": "0612890678",
      "phoneCountryCode": "+212",
      "isEmployed": true,
      "employerName": "Adria Corporation",
      "revenueAmount": "150032",
      "profession": "210",
      "professionalAmount": 75000,
      "primaryEmail": "samir.mouaalim@yahoo.com",
      "activityDomain": "0007",
      "maritalStatus": "2",
      "childrenNumber": 2,
      "motherName": "Sara Mouttaa",
      "birthDate": "24-08-1991",
      "birthDateFormatted": "2005-08-23T22:00:00Z",
      "birthPlace": "MAROC",
      "residencePlace": "MAROC",
      "headquartersAddress": "123 Business Street",
      "isUsTaxPayer": false,
      "segment": "P_SegmentClientContrat",
      "hasWalletSubscription": true,
      "eBankingSubscription": true,
      "status": "ACTIVE",
      "isEBankingActivated": true,
      "bankCode": "00010",
      "contractId": "3905",
      "userId": "2c9180878e66bd67018e6d6a6da90000",
      "attachmentDescription": "Passport scan",
      "walletLevel": "2",
      "city": "CASABLANCA",
      "country": "USA",
      "postalCode": "43000",
      "email": "ibramini.mohammed@email.com",
      "onboardingDate": "2024-01-01",
      "productType": "SAVINGS_ACCOUNT",
      "files": [
        "string"
      ],
      "signature": "string",
      "upgradeId": "789",
      "currentType": "STANDARD",
      "targetType": "PREMIUM",
      "upgradeStatus": "PENDING",
      "upgradeDate": "2024-02-01T00:00:00Z",
      "upgradeDateFormatted": "2024-02-01",
      "rejectionReason": "INCOMPLETE_DOCUMENTATION",
      "currentAccountType": "INDIVIDUAL",
      "idDocumentTypeLabel": "Passport",
      "subscriberTitleLabel": "M",
      "professionLabel": "Software Engineer",
      "activityDomainLabel": "Information Technology",
      "maritalStatusLabel": "Married",
      "birthPlaceLabel": "New York City",
      "residencePlaceLabel": "Manhattan, NY",
      "segmentLabel": "Premium Customer",
      "customerType": "INDIVIDUAL",
      "language": "fr",
      "nationalityCode": "USA",
      "middleName": "ROBERT",
      "gender": "M",
      "birthCountry": "USA",
      "idPaperDeliveryPlace": "NKTT",
      "issuingOrganization": "US STATE DEPARTMENT",
      "nationalIdentifier": "123-45-6789",
      "birthCity": "CASABLANCA",
      "territorialityCode": "US-NY",
      "branchCode": "NYC001",
      "countryCode": "USA",
      "customerOfficer": "AGENT123",
      "qualityCode": "A1",
      "taxableCustomer": "YES",
      "freeAttributes": [
        {
          "customerCode": "CUST123",
          "additionalData": {
            "identifier": "DATA_001",
            "value": {
              "alphanumeric": "ABC123",
              "amountOrRate": 1234.56,
              "date": "31-12-2024"
            }
          },
          "freeText": "Special customer requirements"
        }
      ],
      "declaredHome": "OWNED",
      "economicAgentCode": "EAC123",
      "customerActivityFieldCode": "IT_SERVICES",
      "bankRelationship": "PRIMARY",
      "addresses": [
        {
          "type": "HOME",
          "languageCode": "fr",
          "addressFormat": "STANDARD",
          "addressLine1": "123 Rue Mohammed V",
          "addressLine2": "Appartement 4B",
          "addressLine3": "Quartier des Affaires",
          "city": "Casablanca",
          "countryCode": "MA",
          "branchCode": "00004",
          "geographicalDepartment": "CAS"
        }
      ],
      "phoneNumbers": [
        {
          "identifier": {
            "customerCode": "CUST123",
            "type": "MOBILE"
          },
          "phoneNumber": "+1-555-123-4567",
          "format": "E164"
        }
      ],
      "professionsAndIncomes": [
        {
          "hireDate": "15-01-2024",
          "professionCode": "ENG001",
          "employerCode": "EMP123",
          "incomesBracketCode": "IB500K",
          "employerDepartment": "IT Department"
        }
      ],
      "pmlDefault": "LOW_RISK",
      "profileCode": "PRF001",
      "accountCreation": {
        "productCode": "SAV001",
        "accountClassCode": "PERSONAL",
        "accountType": "SAVINGS",
        "taxableAccount": "Y",
        "accountSubjectToInterestCalculation": "Y",
        "frequencyOfDebitInterestCalculation": "MONTHLY",
        "frequencyOfCreditInterestCalculation": "MONTHLY",
        "codeForInterestLadderPrinting": "STD",
        "accountSubjectToDeductionAtSource": "Y",
        "maturityDate": "2025-12-31",
        "serviceCode": "PREMIUM",
        "accountStatementCode": "MONTHLY",
        "accountStatementDeliveryMethod": "EMAIL",
        "thresholdForReorderingCheques": "5",
        "defaultChequeBookType": "STD25",
        "chequeDeliveryMethod": "BRANCH",
        "branchThatDeliveredTheChequeBook": "BR001",
        "agenceDigital": "DIG001"
      },
      "documents": [
        {
          "id_country": "MA",
          "id_expiry": "31-12-2025",
          "id_number": "AB123456",
          "id_type": "PASSPORT",
          "reference": "DOC-2023-001",
          "radical": "CLI",
          "documentNatureCode": "CONT001",
          "documentName": "Contract Agreement",
          "confidential": "Y",
          "file": "contract_12345.pdf",
          "fileBytes": "string",
          "codeBanque": "BNK001"
        }
      ],
      "function": "EMPLOYEE",
      "offerType": "PREMIUM_PACKAGE",
      "documentID": "passport.pdf",
      "photo": "profile.jpg",
      "addressProof": "utility_bill.pdf",
      "incomeProof": "payslip.pdf",
      "agency": "00020",
      "other": "Additional notes",
      "commercialOffers": [
        "193"
      ],
      "professionalProfiles": [
        "TRADE_FINANCE_CAUTION_BO",
        "TRADE_FINANCE_GUARANTEE_BO",
        "BO_CREATEUR_VALIDATEUR"
      ],
      "languageCode": "EN",
      "filesContent": [
        {
          "fileName": "document.pdf",
          "fileContent": "base64_encoded_content",
          "fileType": "pdf",
          "radical": "CLI",
          "codeBanque": "00014"
        }
      ],
      "hireDate": "23-08-2023",
      "accountNumber": "1234567890",
      "statusLabel": "Active Account",
      "requestId": "EER00085C_ADRIA",
      "incomeBracketCode": "B3"
    }
  ],
  "total": 0,
  "page": 0,
  "size": 0,
  "totalPages": 0
}