Skip to Main Content
Riverty Docs
    riverty logo Docs

    Search for a Claim

    Path

    GET /claims/search

    Request Parameters

    X-Client-Global-Id
    number
    Client Global Id header. Used for internal communication only
    X-Client-Reference
    array
    Client reference header. Used for internal communication only
    page
    integer default: 1
    The current page number.
    pageSize
    integer default: 10
    The number of items per page.
    claimNumber
    string
    claim number to search for
    customerNumber
    string
    customer number given by the client to search for
    contractNumber
    string
    contract number to search for
    invoiceNumber
    string
    invoice number to search for
    ssn
    string
    Social security number / Company number to search for (only supported for countries where people have an SSN)

    Responses

    • array
      claimNumber
      string
      customerNumber
      string
      array
      list of invoices
      customerDisplayName
      string
      Combined first name and last name or company name
      status
      string
      Enum:
      • REJECTED
      • IN_CREATION
      • PROCESSING
      • PAUSED
      • CLOSED
      array
      A set of actions than can be executed on the claim
      object
      A claim consisting of multiple sub-claims, e.g. for contracts within a claim.
      claimType
      string
      Enum:
      • JOINT_CLAIM
      • SUB_CLAIM
      • STAND_ALONE
      The type of claim that exists for joint claims.
      jointClaimNumber
      string
      The identifier of the claim being searched for.
      array
      All additional claims identifier(es) if the searched for claim is the main claim.
      ssn
      string
      Social security number / Company number to search for (only supported for countries where people have an SSN)
      object
      Pagination information for the response.
      totalItems
      required
      integer
      The total number of items available.
      pageSize
      required
      integer
      The number of items per page.
      currentPage
      required
      integer
      The current page number.
      totalPages
      required
      integer
      The total number of pages.
    • 400 bad request
    • 401 request not authorized
    • 403 request forbidden
    Successful Request

    Request Example

        
        null

    Response Example

        
        {
 "items": [
  {
   "status": "PROCESSING",
   "claimNumber": "731770919",
   "customerNumber": "K1644779365",
   "invoiceNumbers": [
    "I1724732257"
   ],
   "availableActions": [
    "CREATE_RECALL"
   ],
   "customerDisplayName": "Eldridge Howe",
   "additionalProperties": {}
  }
 ],
 "pagination": {
  "totalItems": 0,
  "additionalProperties": {}
 },
 "additionalProperties": {}
}