--- title: "Get a contact by customerId and contactId" method: GET path: "/customers/{customerId}/contacts/{contactId}" --- # Get a contact by customerId and contactId `GET /customers/{customerId}/contacts/{contactId}` ## Request - Base URL: `https://api.open-finance.ai/v3/loans` - URL: `https://api.open-finance.ai/v3/loans/customers/{customerId}/contacts/{contactId}` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.open-finance.ai/oauth/token` scopes: `read:contacts` ## Path parameters - `customerId` string, required - `contactId` string, required ## Response `200` Successfully retrieved contact - object - `count` integer - `items` Contact[] - `PK` string: Primary Key - `SK` string: Sort Key - `orgId` string: Organization ID - `userId` string: User ID associated with the contact - `sessionId` string: Session ID - `journeyId` string: Journey ID - `journeyUrl` string: Journey URL - `customerId` string: Customer ID - `contactId` string: Contact ID - `isAdvisor` boolean: Indicates if the contact is an advisor - `isGuarantor` boolean: Indicates if the contact is a guarantor - `isMainContact` boolean: Indicates if the contact is the main contact - `guarantorForSessionId` string: Session ID for which the contact is a guarantor - `isAccountant` boolean: Indicates if the contact is an accountant - `accountantForContactId` string: Contact ID for which the contact is an accountant - `isPartner` boolean: Indicates if the contact is a partner - `partnerForCustomerId` string: Customer ID for which the contact is a partner - `partnerRole` string: Role of the partner - `partnerHasAuthority` boolean: Indicates if the partner has authority - `isPowerOfAttorney` boolean: Indicates if the contact has power of attorney - `isSignificantOther` boolean: Indicates if the contact is a significant other - `significantOtherForContactId` string: Contact ID for which the contact is a significant other - `isAgent` boolean: Indicates if the contact is an agent - `agentForContactId` string: Contact ID for which the contact is an agent - `contactFirstName` string: First name of the contact - `contactLastName` string: Last name of the contact - `contactEmail` string: Email address of the contact - `contactPhone` string: Phone number of the contact - `contactPhoneAtHome` string: Home phone number of the contact - `contactPhoneAtWork` string: Work phone number of the contact - `contactBirthDate` string: Birth date of the contact - `contactGender` 'Male' | 'Female' | 'Other': Gender of the contact - `contactMaritalStatus` 'Single' | 'Married' | 'Widowed' | 'Divorced' | 'SingleParent': Marital status of the contact - `contactNationalId` string: National ID of the contact - `contactNationalIdIssueDate` string: Date when the national ID was issued - `contactNationalIdExpiryDate` string: Expiry date of the national ID - `contactCityName` string: City name of the contact - `contactCityNumber` number: City number of the contact - `contactStreetName` string: Street name of the contact - `contactStreetNumber` number: Street number of the contact - `contactHouseNumber` number: House number of the contact - `contactApartmentNumber` number: Apartment number of the contact - `contactPostOfficeBox` number: Post office box number of the contact - `contactZipCode` number: Zip code of the contact - `geoId` string: Geographical ID - `contactEmploymentStatus` string: Employment status of the contact - `contactOccupationType` string: Occupation type of the contact - `approveMailingList` boolean: Indicates if the contact approves mailing list - `joinMembershipClub` boolean: Indicates if the contact joins the membership club - `creditInfoHasUserConsented` boolean: Indicates if the contact has consented to credit information - `creditInfoConsentDate` string: Date of credit information consent - `creditInfoConsentDateApprovedDeal` string: Date when the deal was approved with credit information - `contactHasConnections` boolean: Indicates if the contact has connections - `contactFiles` OtherDocRecorded[]: Files associated with the contact - `timestamp` number: Timestamp of when the document was recorded - `fileName` string: Name of the file - `bucketPath` string: S3 bucket path where the file is stored - `bucketFileName` string: Name of the file in the S3 bucket - `processType` 'PCN' | '6111' | 'OSH' | 'ESSNA': Type of process the file is associated with - `url` string: URL to access the file - `contactHasFiles` boolean: Indicates if the contact has files - `contactHasCreditReport` boolean: Indicates if the contact has a credit report - `contactJ5FinalizedRedirectUrl` string: J5 finalized redirect URL - `contactJ5Url` string: J5 URL - `contactJ5PrivateKey` string: J5 private key - `contactJ5ReceiptNumber` string: J5 receipt number - `contactJ5TokenNumber` string: J5 token number - `contactJ5Message` string: J5 message - `contactJ5ResponseCode` string: J5 response code - `contactAdvanscreenTerrorList` object: Advanscreen Terror List - `rawResponse` object[] - `ListItem` string - `ReturnValue` boolean - `decision` number - `contactBlacklist` object: Blacklist - `result` number: Blacklist result - `resultDescription` string: Description of the blacklist result - `idBest` string: Best ID for the blacklist - `nameBest` string: Best name for the blacklist - `primaryNameBest` string: Primary best name for the blacklist - `origin` string: Origin of the blacklist result - `addressBest` string: Best address for the blacklist - `codeBest` string: Best code for the blacklist - `maxRank` number: Maximum rank for the blacklist - `totalResult` number: Total result count for the blacklist - `contactDnbReportId` string: DNB report ID - `contactDnbError` boolean: Indicates if there was an error with DNB report - `contactDataHarbor` DBDataHarborPrivateKeys - `dhArrearsDefault` string - `dhDecision` string - `dhDefaultBankruptcyLast3Years` string - `dhDefaultBouncedCheckPrivet` string - `dhDefaultDebtForgivenes` string - `dhDefaultExecutionProceedingandQ7FInal` string - `dhDefaultLimitedFinancialfinal` string - `dhDefaultRestrictedAccountlast3Years` string - `dhFinalOsekScore` string - `dhFinalPrivetScore` string - `dhLegalProcedureDefaultFinalPrivet` string - `dhLessThen3MonthHistory` string - `dhNOGODBScoreFinal` string - `dhNOGOArrearsBussinesFinal` string - `dhNOGOBankruptcyLast3Years` string - `dhNOGOCrediC` string - `dhNOGODebtForgivenesBusiness` string - `dhNOGODebtForgivenesPrivet` string - `dhNOGODebtRestructuringBusiness` string - `dhNOGODebtRestructuringPrivet` string - `dhNOGOExecutionProceedingFInalBussines` string - `dhNOGOExecutionProceedingPrivetFinal` string - `dhNOGOLegalProcedureBussinesFinal` string - `dhNOGOLegalProcedurePrivetFinal` string - `dhNOGOLessThan3monthshist` string - `dhNOGOLimitedFinancialfinal` string - `dhNOGORestrictedAccountlast3Years` string - `dhNOGOp` string - `dhNoGoArrearsPrivetFinal` string - `dhNogoAge` string - `dhNogoAgeandNoHistoryBussinesFinal` string - `dhNogoSocioeconomic` string - `dhOsekQ11Desc` string - `dhOsekQ11` string - `dhOsekQ13Desc` string - `dhOsekQ13` string - `dhOsekQ14Desc` string - `dhOsekQ14` string - `dhOsekQ15Desc` string - `dhOsekQ15` string - `dhOsekQ16Desc` string - `dhOsekQ16` string - `dhOsekQ1Desc` string - `dhOsekQ1` string - `dhOsekQ3Desc` string - `dhOsekQ3` string - `dhOsekQ4Desc` string - `dhOsekQ4` string - `dhOsekQ5Desc` string - `dhOsekQ5` string - `dhOsekQ6Desc` string - `dhOsekQ6` string - `dhOsekQ7Desc` string - `dhOsekQ7` string - `dhOsekQ9Desc` string - `dhOsekQ9` string - `dhPeriodDate` string - `dhPrivetQ10Desc` string - `dhPrivetQ10` string - `dhPrivetQ11Desc` string - `dhPrivetQ11` string - `dhPrivetQ12Desc` string - `dhPrivetQ12` string - `dhPrivetQ13Desc` string - `dhPrivetQ13` string - `dhPrivetQ14Desc` string - `dhPrivetQ14` string - `dhPrivetQ1Desc` string - `dhPrivetQ1` string - `dhPrivetQ2Desc` string - `dhPrivetQ2` string - `dhPrivetQ3Desc` string - `dhPrivetQ3` string - `dhPrivetQ4Desc` string - `dhPrivetQ4` string - `dhPrivetQ5Desc` string - `dhPrivetQ5` string - `dhPrivetQ6Desc` string - `dhPrivetQ6` string - `dhPrivetQ7Desc` string - `dhPrivetQ7` string - `dhPrivetQ8Desc` string - `dhPrivetQ8` string - `dhPrivetQ9Desc` string - `dhPrivetQ9` string - `contactBdiData` DBBdiKeys - `cwaFlagged` boolean: Flag indicating if CWA is flagged - `cwaCode` number: CWA code - `bdiRecommendationCode` number: BDI recommendation code - `bdiRecommendationMessage` string: BDI recommendation message - `contactAgreePromotionsConsented` boolean: Enable to receive professional content on managerial mentoring, financial guidance, and credit. - `createdAt` string: Date when the contact was created - `updatedAt` string: Date when the contact was last updated ## Other responses - `400`: Bad Request - `403`: Forbidden - `500`: Internal Server Error --- [API](https://skmtc.dev/open-finance/apis/loans.md) - [All operations](https://skmtc.dev/open-finance/apis/loans/llms.txt) - [OpenAPI document](https://skmtc.dev/open-finance/apis/loans/revisions/915c69e62042?raw)