Get Credit Scores – Retrieves credit scores for a user associated with an account.

post

https://example.com/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/getCreditScores

Retrieves credit scores for the specified user and account. Optional date range filters can be provided. Returns the user's credit scores and related information.

Path Params

programCode

string

required

The program code associated with the request.

accountIdentifier

string

required

The unique identifier of the account associated with the user. Must be a valid GUID.

userIdentifier

string

required

The unique identifier of the user whose credit scores are being retrieved. Must be a valid GUID.

Body Params

The Gd.Bos.DataTransfer.Request.GetCreditScoresRequest object containing optional date range filters for the credit scores.

Represents a request to retrieve a user's credit scores for a specified date range.
Contains the account and user identifiers, as well as the start and end dates for the credit score query.
Used in the Get Credit Scores API to fetch credit score history or point-in-time scores for compliance, risk assessment, or user reporting.
Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.

startDate

string | null

The start date (inclusive) for the credit score query, typically in ISO 8601 format (e.g., "YYYY-MM-DD").

endDate

string | null

The end date (inclusive) for the credit score query, typically in ISO 8601 format (e.g., "YYYY-MM-DD").

Headers

X-GD-RequestId

string

required

The unique request identifier for idempotency and tracking.
Must be provided in the X-GD-RequestId header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

200OK

403Forbidden

500Internal Server Error

503Service Unavailable