CRS

REST API for MWARE Users

Retention Log

get/users/retention/{id}

Request

path Parameters

required

string <uuid>

Responses

200

Request samples

curl
JavaScript
Python

Response samples

application/json

{"rawRequest": "string",
"rawResponse": "string",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"rawClientRequest": "string",
"rawRequestHeaders": "string",
"crsStandardFormatRequest": "string",
"crsStandardFormatResponse": "string",
"rawClientResponse": "string",
"rawResponseHeaders": "string",
"type": "MCL",
"requestLog": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parent": { },
"children": [{ }
],
"type": "MCL",
"user": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"lastModifiedBy": "ac5c7580-b36d-42f3-a739-e202c634d1d1",
"lastModifiedByIp": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientName": "string",
"clientNumber": "string",
"name": "string",
"email": "string",
"roles": 0,
"configDetails": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"lastModifiedBy": "ac5c7580-b36d-42f3-a739-e202c634d1d1",
"lastModifiedByIp": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"queryString": "string",
"dailyMaxRequests": 0,
"monthlyMaxRequests": 0,
"configName": "string",
"configValue": {"crossCore": {"subscriberCode": "string",
"productOption": "string",
"correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
"hasOTP": true,
"hasKIQ": true
},
"transUnionCreditProfile": {"industryCode": "string",
"memberCode": "string",
"memberPassword": "string",
"subcode": "string",
"permissiblePurpose": "string",
"credentials": {"keyPassphrase": null,
"certificateFileName": null
},
"pdfEnabled": true,
"crsPdfEnabled": true,
"customPdfEnabled": true,
"crsStandardFormatConfigItem": {"crsStandardFormatAddOnConfigs": [ ],
"requestValidationEnabled": null,
"cachingEnabled": null,
"allowAllZeroesSSN": null,
"hideInquiriesOlderThanDays": null,
"downgradeAccountStatusTypes": null,
"publicRecordPaidDateAsDispositionDate": null,
"fineTuneCollectionOrChargeOffCurrentRating": null,
"addTradelineChargedOffAmount": null,
"defaultMiscellaneousBusinessTypeToFinance": null,
"downgradeLoanTypes": null,
"downgradeAdverseRatingTypes": null,
"mortgageAccountTypeOverrides": null,
"collectionOverrides": null,
"educationalOverrides": null,
"customOverrides": null,
"setMonthlyPaymentToZeroIfPaid": null,
"setCreditLimitAsHighCredit": null,
"addCreditLoanTypesAsComments": null,
"replaceLastActivityDateAsPaidDate": null,
"setNullAmountsToZeroExperian": null,
"fillInMissingDataEquifax": null
},
"customPdfConfig": {"maskSSN": null,
"creditReportTradeSummaryEnabled": null,
"creditReportDerogatorySummaryEnabled": null,
"hideScoreSection": null,
"highlightDerogatoryTradelines": null
},
"crsTradeSummaryEnabled": true,
"crsDerogatorySummaryEnabled": true,
"addOnProducts": [null
]
},
"efxCreditProfile": {"crsStandardFormatConfigItem": {"crsStandardFormatAddOnConfigs": [ ],
"requestValidationEnabled": null,
"cachingEnabled": null,
"allowAllZeroesSSN": null,
"hideInquiriesOlderThanDays": null,
"downgradeAccountStatusTypes": null,
"publicRecordPaidDateAsDispositionDate": null,
"fineTuneCollectionOrChargeOffCurrentRating": null,
"addTradelineChargedOffAmount": null,
"defaultMiscellaneousBusinessTypeToFinance": null,
"downgradeLoanTypes": null,
"downgradeAdverseRatingTypes": null,
"mortgageAccountTypeOverrides": null,
"collectionOverrides": null,
"educationalOverrides": null,
"customOverrides": null,
"setMonthlyPaymentToZeroIfPaid": null,
"setCreditLimitAsHighCredit": null,
"addCreditLoanTypesAsComments": null,
"replaceLastActivityDateAsPaidDate": null,
"setNullAmountsToZeroExperian": null,
"fillInMissingDataEquifax": null
},
"customPdfConfig": {"maskSSN": null,
"creditReportTradeSummaryEnabled": null,
"creditReportDerogatorySummaryEnabled": null,
"hideScoreSection": null,
"highlightDerogatoryTradelines": null
},
"memberNumber": "string",
"securityCode": "string",
"codeDescriptionRequired": true,
"endUsersName": "string",
"permissiblePurposeCode": "string",
"productCodes": [null
],
"models": [null
],
"customerCode": "string",
"multipleReportIndicator": "string",
"ecOAInquiryType": "string",
"optionalFeatureCode": [null
],
"pdfEnabled": true,
"vendorIdentificationCode": "string",
"riskModelCodeOnly": "string"
},
"experianCreditProfile": {"authenticationConfig": {"username": null,
"password": null,
"clientId": null,
"clientSecret": null,
"enabled": null
},
"crsStandardFormatConfigItem": {"crsStandardFormatAddOnConfigs": [ ],
"requestValidationEnabled": null,
"cachingEnabled": null,
"allowAllZeroesSSN": null,
"hideInquiriesOlderThanDays": null,
"downgradeAccountStatusTypes": null,
"publicRecordPaidDateAsDispositionDate": null,
"fineTuneCollectionOrChargeOffCurrentRating": null,
"addTradelineChargedOffAmount": null,
"defaultMiscellaneousBusinessTypeToFinance": null,
"downgradeLoanTypes": null,
"downgradeAdverseRatingTypes": null,
"mortgageAccountTypeOverrides": null,
"collectionOverrides": null,
"educationalOverrides": null,
"customOverrides": null,
"setMonthlyPaymentToZeroIfPaid": null,
"setCreditLimitAsHighCredit": null,
"addCreditLoanTypesAsComments": null,
"replaceLastActivityDateAsPaidDate": null,
"setNullAmountsToZeroExperian": null,
"fillInMissingDataEquifax": null
},
"customPdfConfig": {"maskSSN": null,
"creditReportTradeSummaryEnabled": null,
"creditReportDerogatorySummaryEnabled": null,
"hideScoreSection": null,
"highlightDerogatoryTradelines": null
},
"password": "string",
"subcode": "string",
"permissiblePurpose": "string",
"creditProfileAddons": {"directCheck": null,
"demographics": null,
"extendedViewScore": null,
"clarityEarlyRiskScore": null,
"clarityAttributes": null,
"clarityData": null,
"eCBSV": null,
"eCBSVData": null,
"renterRiskScore": null,
"rentBureauData": null,
"riskModels": null,
"summaries": null,
"fraudShield": null,
"mla": null,
"ofacmsg": null,
"consumerIdentCheck": null,
"joint": null,
"paymentHistory84": null,
"syntheticId": null,
"taxRefundLoan": null,
"sureProfile": null,
"trendedData": null,
"fcraAttributes": null,
"outputType": null,
"covidSpotlightAttributes": null,
"staggSelect": null,
"incomeAndEmploymentReport": null,
"incomeAndEmploymentReportData": null,
"mlAttributes": null
},
"autoAddons": {"directCheck": null,
"demographics": null,
"extendedViewScore": null,
"clarityEarlyRiskScore": null,
"clarityData": null,
"renterRiskScore": null,
"rentBureauData": null,
"riskModels": null,
"summaries": null,
"fraudShield": null,
"mla": null,
"ofacmsg": null,
"consumerIdentCheck": null,
"joint": null,
"paymentHistory84": null
},
"healthAddons": {"directCheck": null,
"demographics": null,
"extendedViewScore": null,
"clarityEarlyRiskScore": null,
"clarityData": null,
"riskModels": null,
"summaries": null,
"fraudShield": null,
"mla": null,
"ofacmsg": null,
"consumerIdentCheck": null,
"joint": null,
"paymentHistory84": null
},
"tecAddons": {"directCheck": null,
"demographics": null,
"clarityEarlyRiskScore": null,
"clarityData": null,
"renterRiskScore": null,
"rentBureauData": null,
"riskModels": null,
"summaries": null,
"fraudShield": null,
"mla": null,
"ofacmsg": null,
"consumerIdentCheck": null,
"joint": null,
"paymentHistory84": null
}
},
"xgsReport": {"defaultSearch": "string"
},
"ppCriminalReport": {"key": "string"
},
"ppPropertyReport": {"key": "string"
},
"ppFcrabljReport": {"key": "string"
},
"ppGlbbljReport": {"key": "string"
},
"ppForeclosureReport": {"key": "string"
},
"criminalReport": {"authenticationConfig": {"username": null,
"password": null,
"enabled": null
},
"notificationEmailAddress": "string",
"key": "string"
},
"evictionReport": {"authenticationConfig": {"username": null,
"password": null,
"enabled": null
},
"key": "string"
},
"biidReport": {"key": "string"
},
"iidReport": {"key": "string"
},
"vfpsReport": {"key": "string",
"options": {"globalWatchlistThreshold": null,
"watchListsRequested": null,
"biid20ProductType": null,
"exactAddrMatch": null,
"exactDOBMatch": null,
"exactDriverLicenseMatch": null,
"exactFirstNameMatch": null,
"exactFirstNameMatchAllowNicknames": null,
"exactLastNameMatch": null,
"exactPhoneMatch": null,
"exactSSNMatch": null,
"excludeWatchLists": null,
"includeAdditionalWatchlists": null,
"includeCLOverride": null,
"includeDLVerification": null,
"includeDOBInCVI": null,
"includeDPBC": null,
"includeDriverLicenseInCVI": null,
"includeMIOverride": null,
"includeMSOverride": null,
"includeOFAC": null,
"lastSeenThreshold": null,
"nameInputOrder": null,
"poBoxCompliance": null,
"useDOBFilter": null,
"attributesVersionRequest": null,
"includeModels": null,
"dobmatchOptions": null,
"dobradius": null
},
"user": { },
"pdfEnabled": true
},
"experianRpa": {"key": "string"
},
"experianCommandCredit": {"useExperianBusinessDirectConnection": true
},
"experianBusiness": {"subcode": "string",
"modelCode": "string"
},
"riskViewReport": {"key": "string"
},
"lienJudgmentSearch": {"dlPurpose": "string",
"glbPurpose": "string"
},
"truValidate": {"key": "string"
},
"ubiquityDataFurnishing": {"authenticationConfig": {"id": null,
"secret": null,
"companyId": null,
"enabled": null
}
},
"mismoConfigItem": {"login": "string",
"password": "string",
"retentionPeriodInDays": 0,
"transunionProductCode": "string",
"equifaxProductCode": "string",
"experianProductCode": "string",
"dataFormat": "string",
"duplicateDetectionEnabled": true,
"retentionPolicyEnabled": true,
"equifaxEnabled": true,
"transunionEnabled": true,
"experianEnabled": true,
"apiAccessEnabled": true,
"webAccessEnabled": true,
"forceMcl": true
},
"atDataFraudPreventionConfigItem": {"key": "string"
},
"instantID": {"key": "string"
}
},
"description": "string",
"billingCode": "string",
"internalNote": "string",
"product": "string",
"autoGenerated": true,
"sourceConfig": { },
"productPricing": {"pricingTiers": [{"minRequests": null,
"maxRequests": null,
"price": null,
"enabled": null
}
],
"hasPricingTiersEnabled": true,
"billingAmount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"tieredModelPricingEnabled": true,
"volumeModelPricingEnabled": true
},
"default": true,
"enabled": true
}
],
"enabled": true,
"disableReason": "string",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
},
"userConfig": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"lastModifiedBy": "ac5c7580-b36d-42f3-a739-e202c634d1d1",
"lastModifiedByIp": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"queryString": "string",
"dailyMaxRequests": 0,
"monthlyMaxRequests": 0,
"configName": "string",
"configValue": {"crossCore": {"subscriberCode": "string",
"productOption": "string",
"correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
"hasOTP": true,
"hasKIQ": true
},
"transUnionCreditProfile": {"industryCode": "string",
"memberCode": "string",
"memberPassword": "string",
"subcode": "string",
"permissiblePurpose": "string",
"credentials": {"keyPassphrase": "string",
"certificateFileName": "string"
},
"pdfEnabled": true,
"crsPdfEnabled": true,
"customPdfEnabled": true,
"crsStandardFormatConfigItem": {"crsStandardFormatAddOnConfigs": [{"userConfigReferenceId": null,
"isEnabled": null,
"requestLogType": null
}
],
"requestValidationEnabled": true,
"cachingEnabled": true,
"allowAllZeroesSSN": true,
"hideInquiriesOlderThanDays": 0,
"downgradeAccountStatusTypes": true,
"publicRecordPaidDateAsDispositionDate": true,
"fineTuneCollectionOrChargeOffCurrentRating": true,
"addTradelineChargedOffAmount": true,
"defaultMiscellaneousBusinessTypeToFinance": true,
"downgradeLoanTypes": true,
"downgradeAdverseRatingTypes": true,
"mortgageAccountTypeOverrides": true,
"collectionOverrides": true,
"educationalOverrides": true,
"customOverrides": true,
"setMonthlyPaymentToZeroIfPaid": true,
"setCreditLimitAsHighCredit": true,
"addCreditLoanTypesAsComments": true,
"replaceLastActivityDateAsPaidDate": true,
"setNullAmountsToZeroExperian": true,
"fillInMissingDataEquifax": true
},
"customPdfConfig": {"maskSSN": true,
"creditReportTradeSummaryEnabled": true,
"creditReportDerogatorySummaryEnabled": true,
"hideScoreSection": true,
"highlightDerogatoryTradelines": true
},
"crsTradeSummaryEnabled": true,
"crsDerogatorySummaryEnabled": true,
"addOnProducts": [{"code": "string",
"scoreModelProduct": true
}
]
},
"efxCreditProfile": {"crsStandardFormatConfigItem": {"crsStandardFormatAddOnConfigs": [{"userConfigReferenceId": null,
"isEnabled": null,
"requestLogType": null
}
],
"requestValidationEnabled": true,
"cachingEnabled": true,
"allowAllZeroesSSN": true,
"hideInquiriesOlderThanDays": 0,
"downgradeAccountStatusTypes": true,
"publicRecordPaidDateAsDispositionDate": true,
"fineTuneCollectionOrChargeOffCurrentRating": true,
"addTradelineChargedOffAmount": true,
"defaultMiscellaneousBusinessTypeToFinance": true,
"downgradeLoanTypes": true,
"downgradeAdverseRatingTypes": true,
"mortgageAccountTypeOverrides": true,
"collectionOverrides": true,
"educationalOverrides": true,
"customOverrides": true,
"setMonthlyPaymentToZeroIfPaid": true,
"setCreditLimitAsHighCredit": true,
"addCreditLoanTypesAsComments": true,
"replaceLastActivityDateAsPaidDate": true,
"setNullAmountsToZeroExperian": true,
"fillInMissingDataEquifax": true
},
"customPdfConfig": {"maskSSN": true,
"creditReportTradeSummaryEnabled": true,
"creditReportDerogatorySummaryEnabled": true,
"hideScoreSection": true,
"highlightDerogatoryTradelines": true
},
"memberNumber": "string",
"securityCode": "string",
"codeDescriptionRequired": true,
"endUsersName": "string",
"permissiblePurposeCode": "string",
"productCodes": ["string"
],
"models": [{"identifier": "string",
"modelField": [null
]
}
],
"customerCode": "string",
"multipleReportIndicator": "string",
"ecOAInquiryType": "string",
"optionalFeatureCode": ["string"
],
"pdfEnabled": true,
"vendorIdentificationCode": "string",
"riskModelCodeOnly": "string"
},
"experianCreditProfile": {"authenticationConfig": {"username": "string",
"password": "string",
"clientId": "string",
"clientSecret": "string",
"enabled": true
},
"crsStandardFormatConfigItem": {"crsStandardFormatAddOnConfigs": [{"userConfigReferenceId": null,
"isEnabled": null,
"requestLogType": null
}
],
"requestValidationEnabled": true,
"cachingEnabled": true,
"allowAllZeroesSSN": true,
"hideInquiriesOlderThanDays": 0,
"downgradeAccountStatusTypes": true,
"publicRecordPaidDateAsDispositionDate": true,
"fineTuneCollectionOrChargeOffCurrentRating": true,
"addTradelineChargedOffAmount": true,
"defaultMiscellaneousBusinessTypeToFinance": true,
"downgradeLoanTypes": true,
"downgradeAdverseRatingTypes": true,
"mortgageAccountTypeOverrides": true,
"collectionOverrides": true,
"educationalOverrides": true,
"customOverrides": true,
"setMonthlyPaymentToZeroIfPaid": true,
"setCreditLimitAsHighCredit": true,
"addCreditLoanTypesAsComments": true,
"replaceLastActivityDateAsPaidDate": true,
"setNullAmountsToZeroExperian": true,
"fillInMissingDataEquifax": true
},
"customPdfConfig": {"maskSSN": true,
"creditReportTradeSummaryEnabled": true,
"creditReportDerogatorySummaryEnabled": true,
"hideScoreSection": true,
"highlightDerogatoryTradelines": true
},
"password": "string",
"subcode": "string",
"permissiblePurpose": "string",
"creditProfileAddons": {"directCheck": "string",
"demographics": "string",
"extendedViewScore": "string",
"clarityEarlyRiskScore": "string",
"clarityAttributes": "string",
"clarityData": {"clarityAccountId": "string",
"clarityLocationId": "string",
"clarityControlFileName": "string",
"clarityControlFileVersion": "string",
"clarityAttributesControlFileName": "string"
},
"eCBSV": "string",
"eCBSVData": {"employerIdentificationNumber": "string",
"consentDate": "string",
"consentType": "string"
},
"renterRiskScore": "string",
"rentBureauData": {"primaryApplRentBureauFreezePin": "string",
"secondaryApplRentBureauFreezePin": "string"
},
"riskModels": {"modelIndicator": [null
],
"scorePercentile": "string"
},
"summaries": {"summaryType": [null
]
},
"fraudShield": "string",
"mla": "string",
"ofacmsg": "string",
"consumerIdentCheck": {"getUniqueConsumerIdentifier": "string",
"verifyPrimaryConsumerIdentifier": "string",
"verifySecondaryConsumerIdentifier": "string"
},
"joint": "string",
"paymentHistory84": "string",
"syntheticId": "string",
"taxRefundLoan": "string",
"sureProfile": "string",
"trendedData": "string",
"fcraAttributes": "string",
"outputType": "string",
"covidSpotlightAttributes": "string",
"staggSelect": "string",
"incomeAndEmploymentReport": "string",
"incomeAndEmploymentReportData": {"verifierName": "string",
"reportType": "string"
},
"mlAttributes": "string"
},
"autoAddons": {"directCheck": "string",
"demographics": "string",
"extendedViewScore": "string",
"clarityEarlyRiskScore": "string",
"clarityData": {"clarityAccountId": "string",
"clarityLocationId": "string",
"clarityControlFileName": "string",
"clarityControlFileVersion": "string"
},
"renterRiskScore": "string",
"rentBureauData": {"primaryApplRentBureauFreezePin": "string",
"secondaryApplRentBureauFreezePin": "string"
},
"riskModels": {"modelIndicator": [null
],
"scorePercentile": "string"
},
"summaries": {"summaryType": [null
]
},
"fraudShield": "string",
"mla": "string",
"ofacmsg": "string",
"consumerIdentCheck": {"getUniqueConsumerIdentifier": "string",
"verifyPrimaryConsumerIdentifier": "string",
"verifySecondaryConsumerIdentifier": "string"
},
"joint": "string",
"paymentHistory84": "string"
},
"healthAddons": {"directCheck": "string",
"demographics": "string",
"extendedViewScore": "string",
"clarityEarlyRiskScore": "string",
"clarityData": {"clarityAccountId": "string",
"clarityLocationId": "string",
"clarityControlFileName": "string",
"clarityControlFileVersion": "string"
},
"riskModels": {"modelIndicator": [null
],
"scorePercentile": "string"
},
"summaries": {"summaryType": [null
]
},
"fraudShield": "string",
"mla": "string",
"ofacmsg": "string",
"consumerIdentCheck": {"getUniqueConsumerIdentifier": "string",
"verifyPrimaryConsumerIdentifier": "string",
"verifySecondaryConsumerIdentifier": "string"
},
"joint": "string",
"paymentHistory84": "string"
},
"tecAddons": {"directCheck": "string",
"demographics": "string",
"clarityEarlyRiskScore": "string",
"clarityData": {"clarityAccountId": "string",
"clarityLocationId": "string",
"clarityControlFileName": "string",
"clarityControlFileVersion": "string"
},
"renterRiskScore": "string",
"rentBureauData": {"primaryApplRentBureauFreezePin": "string",
"secondaryApplRentBureauFreezePin": "string"
},
"riskModels": {"modelIndicator": [null
],
"scorePercentile": "string"
},
"summaries": {"summaryType": [null
]
},
"fraudShield": "string",
"mla": "string",
"ofacmsg": "string",
"consumerIdentCheck": {"getUniqueConsumerIdentifier": "string",
"verifyPrimaryConsumerIdentifier": "string",
"verifySecondaryConsumerIdentifier": "string"
},
"joint": "string",
"paymentHistory84": "string"
}
},
"xgsReport": {"defaultSearch": "string"
},
"ppCriminalReport": {"key": "string"
},
"ppPropertyReport": {"key": "string"
},
"ppFcrabljReport": {"key": "string"
},
"ppGlbbljReport": {"key": "string"
},
"ppForeclosureReport": {"key": "string"
},
"criminalReport": {"authenticationConfig": {"username": "string",
"password": "string",
"enabled": true
},
"notificationEmailAddress": "string",
"key": "string"
},
"evictionReport": {"authenticationConfig": {"username": "string",
"password": "string",
"enabled": true
},
"key": "string"
},
"biidReport": {"key": "string"
},
"iidReport": {"key": "string"
},
"vfpsReport": {"key": "string",
"options": {"globalWatchlistThreshold": 0,
"watchListsRequested": {"watchList": [null
]
},
"biid20ProductType": 0,
"exactAddrMatch": true,
"exactDOBMatch": true,
"exactDriverLicenseMatch": true,
"exactFirstNameMatch": true,
"exactFirstNameMatchAllowNicknames": true,
"exactLastNameMatch": true,
"exactPhoneMatch": true,
"exactSSNMatch": true,
"excludeWatchLists": true,
"includeAdditionalWatchlists": true,
"includeCLOverride": true,
"includeDLVerification": true,
"includeDOBInCVI": true,
"includeDPBC": true,
"includeDriverLicenseInCVI": true,
"includeMIOverride": true,
"includeMSOverride": true,
"includeOFAC": true,
"lastSeenThreshold": "string",
"nameInputOrder": "string",
"poBoxCompliance": true,
"useDOBFilter": true,
"attributesVersionRequest": {"name": [null
]
},
"includeModels": {"names": {"name": [ ]
},
"modelOptions": {"modelOption": [ ]
}
},
"dobmatchOptions": {"dobmatchOption": [null
]
},
"dobradius": 0
},
"user": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"lastModifiedBy": "ac5c7580-b36d-42f3-a739-e202c634d1d1",
"lastModifiedByIp": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientName": "string",
"clientNumber": "string",
"name": "string",
"email": "string",
"roles": 0,
"configDetails": [{ }
],
"enabled": true,
"disableReason": "string",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac"
},
"pdfEnabled": true
},
"experianRpa": {"key": "string"
},
"experianCommandCredit": {"useExperianBusinessDirectConnection": true
},
"experianBusiness": {"subcode": "string",
"modelCode": "string"
},
"riskViewReport": {"key": "string"
},
"lienJudgmentSearch": {"dlPurpose": "string",
"glbPurpose": "string"
},
"truValidate": {"key": "string"
},
"ubiquityDataFurnishing": {"authenticationConfig": {"id": "string",
"secret": "string",
"companyId": "string",
"enabled": true
}
},
"mismoConfigItem": {"login": "string",
"password": "string",
"retentionPeriodInDays": 0,
"transunionProductCode": "string",
"equifaxProductCode": "string",
"experianProductCode": "string",
"dataFormat": "string",
"duplicateDetectionEnabled": true,
"retentionPolicyEnabled": true,
"equifaxEnabled": true,
"transunionEnabled": true,
"experianEnabled": true,
"apiAccessEnabled": true,
"webAccessEnabled": true,
"forceMcl": true
},
"atDataFraudPreventionConfigItem": {"key": "string"
},
"instantID": {"key": "string"
}
},
"description": "string",
"billingCode": "string",
"internalNote": "string",
"product": "string",
"autoGenerated": true,
"sourceConfig": { },
"productPricing": {"pricingTiers": [{"minRequests": 0,
"maxRequests": 0,
"price": 0,
"enabled": true
}
],
"hasPricingTiersEnabled": true,
"billingAmount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"tieredModelPricingEnabled": true,
"volumeModelPricingEnabled": true
},
"default": true,
"enabled": true
},
"encryptionKey": "91b6dd57-4a8a-424e-9483-39f667230be2",
"ip": 0,
"detail": "string",
"createdAt": "2019-08-24T14:15:22Z",
"status": "string",
"origin": "string",
"method": "string",
"description": "string",
"product": "string",
"url": "string",
"responseCode": "string",
"responseId": "string",
"applicant": "string",
"billable": true
},
"document": "string"
}

Retention Log Details

get/users/retention/{id}/request

Request

path Parameters

required

string <uuid>

Responses

200

Request samples

curl
JavaScript
Python

Retention PDF

get/users/retention-pdf/{id}

Request

path Parameters

required

string <uuid>

Responses

200

Request samples

curl
JavaScript
Python

PDF Consumer Copy

get/users/retention-consumer-copy/{id}

Request

path Parameters

required

string <uuid>

Responses

200

Request samples

curl
JavaScript
Python

User

get/users

Responses

200

Request samples

curl
JavaScript
Python

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientName": "string",
"clientNumber": "string",
"name": "string",
"email": "string",
"roles": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"mclI": "string",
"mclU": "string",
"enabled": true,
"disableReason": "string"
}

User Login

post/users/login

Request

Request Body schema:
application/json

username	string
password	string

Responses

200

Request samples

Payload
curl
JavaScript
Python

{"username": "string",
"password": "string"
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientName": "string",
"clientNumber": "string",
"name": "string",
"email": "string",
"roles": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"mclI": "string",
"mclU": "string",
"enabled": true,
"disableReason": "string",
"token": "string",
"expires": 0,
"refreshToken": "string"
}

Refresh Token

post/users/refresh-token

Request

Request Body schema:
application/json

refreshToken

string

Responses

200

Request samples

Payload
curl
JavaScript
Python

{"refreshToken": "string"
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientName": "string",
"clientNumber": "string",
"name": "string",
"email": "string",
"roles": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"mclI": "string",
"mclU": "string",
"enabled": true,
"disableReason": "string",
"token": "string",
"expires": 0,
"refreshToken": "string"
}

Get System Health Info

get/sys/health

Responses

200

Request samples

curl
JavaScript
Python

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"clientName": "string",
"clientNumber": "string",
"name": "string",
"email": "string",
"roles": 0,
"createdAt": "2019-08-24T14:15:22Z",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"mclI": "string",
"mclU": "string",
"enabled": true,
"disableReason": "string",
"token": "string",
"expires": 0,
"refreshToken": "string"
}

CRS

Retention Log

path Parameters

Retention Log Details

path Parameters

Retention PDF

path Parameters

PDF Consumer Copy

path Parameters

User

User Login

Request Body schema: application/jsonapplication/xmlapplication/json

Refresh Token

Request Body schema: application/jsonapplication/xmlapplication/json

Get System Health Info

Request Body schema:
application/json

Request Body schema:
application/json