List Cdh Account Status Roster
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Restricts results to the given employment statuses. Repeat the parameter to select several; defaults to Active when omitted.
Show child attributes
Restricts results to the given CIP statuses, such as Passed, Pending, or Failed - OFAC. Repeat the parameter to select several.
Show child attributes
Restricts results to the given account statuses, such as Active, Pending CIP, or Close. Repeat the parameter to select several.
Show child attributes
Zero-based page index.
Maximum number of rows to return per page (1-100).
Response
CDH account status roster records retrieved successfully
Response Attributes
The account status roster records for this page.
Show child attributes
Show child attributes
Bad Request – Validation failed. The errors map keys mirror the snake_case JSON property names used in the request payload.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized – Missing or invalid credentials.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden – Insufficient permissions.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Internal Server Error.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: