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" }}Open in Apollo Studio Explorer →
Click the link above to open this query in Apollo Studio Explorer with the query pre-filled. You’ll need to authenticate with your sandbox credentials.
Example Response
{ "data": { "downloadCreditReport": { "data": "JVBERi0xLjQKJeLjz9MK... (Base64-encoded PDF content)", "errors": null } }}Arguments
| Argument | Type | Description |
|---|---|---|
input | DownloadCreditReportInput! | Input containing the credit report ID to download |
Input Types
DownloadCreditReportInput
Input for Downloading the Credit Report Base-64 encoded PDF
Required Fields:
| Field | Type | Description |
|---|---|---|
creditReportId | String! | Internal credit report ID |
Response Type
Returns: DownloadCreditReportResponse
DownloadCreditReportResponse
DownloadCreditReportResponse Response
| Field | Type | Description |
|---|---|---|
data | String | Base64-encoded PDF |
errors | [DownloadCreditReportResponseError] | Error(s) message list |
DownloadCreditReportResponseError
Download document Response Error
| Field | Type | Description |
|---|---|---|
message | String | Error message |
Error Types
The response may include the following error types:
DownloadCreditReportResponseError
Download document Response Error
| Field | Type | Description |
|---|---|---|
message | String | Error message |
Common Errors
| Error Code | Description | Resolution |
|---|---|---|
VALIDATION_ERROR | Input validation failed | Check required fields and formats |
UNAUTHORIZED | Invalid or expired token | Re-authenticate and retry |
NOT_FOUND | Resource not found | Verify the ID or reference |