Skip to content

downloadCreditReport

Query

Get the Base64-encoded PDF of a credit report using the creditReportId. This is the report provided by the original credit report source.

Query Signature

query {
downloadCreditReport(input: DownloadCreditReportInput!): DownloadCreditReportResponse
}

Example Request

query DownloadCreditReport($input: DownloadCreditReportInput!) {
downloadCreditReport(input: $input) {
# Add fields you want to retrieve
}
}

Example Variables:

{
"input": {
"creditReportId": "cr-abc123def456"
}
}

Example Response

{
"data": {
"downloadCreditReport": {
"data": "JVBERi0xLjQKJeLjz9MK... (Base64-encoded PDF content)",
"errors": null
}
}
}

Arguments

ArgumentTypeDescription
inputDownloadCreditReportInput!Input containing the credit report ID to download

Input Types

DownloadCreditReportInput

Input for Downloading the Credit Report Base-64 encoded PDF

Required Fields:

FieldTypeDescription
creditReportIdString!Internal credit report ID

Response Type

Returns: DownloadCreditReportResponse

DownloadCreditReportResponse

DownloadCreditReportResponse Response

FieldTypeDescription
dataStringBase64-encoded PDF
errors[DownloadCreditReportResponseError]Error(s) message list

DownloadCreditReportResponseError

Download document Response Error

FieldTypeDescription
messageStringError message

Error Types

The response may include the following error types:

DownloadCreditReportResponseError

Download document Response Error

FieldTypeDescription
messageStringError message

Common Errors

Error CodeDescriptionResolution
VALIDATION_ERRORInput validation failedCheck required fields and formats
UNAUTHORIZEDInvalid or expired tokenRe-authenticate and retry
NOT_FOUNDResource not foundVerify the ID or reference