Get Claims
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
The GUID of the person (participant). Provide this OR business_entity_id, not both.
The GUID of the business entity. Provide this OR person_id, not both.
The number of claims requested. Pass 0 or omit to return all claims without pagination.
The starting index in the list of claims to be returned. Ignored when page_size is 0 (unpaged).
Response
Successfully retrieved claims
Response Attributes
Current page index (i.e. page number minus one)
Number of items per page
Indicated whether there are additional pages
The total number of claims matching the query across all pages. Used to calculate the total number of pages as ceil(total_results / page_size).
A list of claims
Show child attributes
Invalid request. Must provide exactly one of person_id or business_entity_id.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Show child attributes
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized. Authentication failed.
Response Attributes
List of invalid parameters that caused the validation error.
Show child 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.
Not Found.
Response Attributes
List of invalid parameters that caused the validation error.
Show child 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
A URI reference that identifies the problem type.
A short, human-readable summary of the problem type.
The HTTP status code generated by the origin server.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem.
List of invalid parameters that caused the validation error.
Show child attributes
Unexpected error
Response Attributes
List of invalid parameters that caused the validation error.
Show child 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.