Get a Claim

Responses

• 200 successfull request
  clientNumber

  string

  clientGlobalId

  integer

  Global client identifier from Border Patrol used for user permissions.

  claimNumber

  string

  phase

  string

  Max length: 20

  Enum:

  • PRE_COLLECTION
  • COLLECTION
  • LEGAL
  • POST_LEGAL
  • SURVEILLANCE
  • CLOSED

  statusAttributes

  array

  This is a status that can occur during the collections process, it is possible that several statuses occur at the same time, e.g. if a lawyer is involved LAWYER and if there is an installment agreement at the same time INSTALLMENT INSTALLMENT - If case are part of an installment agreement INVESTIGATION – could be address search, or other reason that Riverty is searching for information regarding the consumer or the claim DISPUTE – The consumer has disputed the claim for some reason and Riverty is working on to solve it DECEASED – Consumer is deceased and we just inform about this INSOLVENCY – Debtor can not pay and are in a process of debt recovery/reconstruction? Budget coach or other 3rd party process to get back in flow BANKRUPTCY – Use case for B2B consumers and some cases B2C LAWYER – The consumer has hired a lawyer to represent him in the case DEFERMENT – if case is put on hold for some reason CONSUMER_LIVING_ABROAD – Consumer has moved abroad and case is handled by Riverty or agent in consumer´s new country

  customer

  object

  A customer is a person serviced by our clients.

  customerNumber

  string

  Max length: 40

  This is the identifier of the customer. Provided by the client.

  segment

  string

  Max length: 70

  This is the segment identifier of the client. If a client has multiple business lines, this field can be used for the separation of business lines.

  identificationNumber

  string

  Max length: 128

  This is the social security number of the customer or company registration number, when the customer is a company.

  title

  string

  Max length: 32

  This is the title of the customer. It will likely be used in mails or letters.

  gender

  string

  Max length: 20

  Enum:

  • MALE
  • FEMALE
  • DIVERSE

  This is the gender of the customer. * `MALE` - The customer's gender is male. * `FEMALE` - The customer's gender is female. * `DIVERSE` - The customer's gender is diverse. * `null` - The customer's gender is unknown.

  firstName

  string

  Max length: 128

  This is for the first name(s) of the customer, separated by either dashes or spaces.

  lastName

  string

  Max length: 256

  This is for the last name(s) of the customer, separated by either dashes or spaces.

  companyName

  string

  Max length: 256

  This is the company name of the customer, separated by either dashes or spaces.

  dateOfBirth

  string

  yyyy-MM-dd

  Max length: 10

  This is the date of birth of the customer. It is needed for legal checks, eg. is the customer underaged.

  type

  string

  Max length: 20

  Enum:

  • PRIVATE
  • COMPANY

  Represents the type of a customer. * `PRIVATE` - The customer is a private individual. * `COMPANY` - The customer is a company.

  category

  string

  Max length: 128

  This is the identifier of the customer. Provided by the client.

  preferredLanguage

  string

  Max length: 2

  This is the language in which the customer wants to be contacted, according to ISO 3166-1 alpha 2.

  dateOfDeath

  string

  yyyy-MM-dd

  Max length: 10

  This is the date of death of the customer.

  addresses

  array

  These are the addresses of the customer and his/her further contact persons.

  street

  string

  Max length: 128

  street or adresse line 1. The street could include the house number, but if possible please provide the house number as separate value in the field houseNumber

  houseNumber

  string

  Max length: 10

  The street / address line 1

  addressLine2

  string

  Max length: 128

  addressLine2, can be used, for example, for an additional address indication

  zipCode

  string

  Max length: 10

  The zip code.

  city

  string

  Max length: 40

  The city.

  countryCode

  string

  Max length: 2

  The country code according to ISO 3166-1 alpha 2.

  careOf

  string

  Max length: 128

  An optional contact person.

  type

  string

  Max length: 20

  Enum:

  • BILLING
  • SHIPPING

  The type expresses which sort of customer address this is * `BILLING` - The address where to send the bills to. * `SHIPPING` - The address where to ship products to.

  communicationChannels

  array

  List of contact channels of the customer.

  type

  string

  Enum:

  • PHONE
  • MOBILE_PHONE
  • EMAIL

  value

  string

  Max length: 120

  the contact information for person or company

  bankAccounts

  array

  List of bank accounts of the customer

  iban

  string

  Max length: 32

  bic

  string

  Max length: 32

  installment

  object

  holds the information for an installment, if there is an installment agreement

  startDate

  string

  yyyy-MM-dd

  the date on which the instalment agreement should start

  endDate

  string

  yyyy-MM-dd

  the date on which the instalment agreement should end

  nextPaymentDate

  string

  yyyy-MM-dd

  the date of the installment must be paid

  amount

  number

  the amount for the next installment

  totalAmount

  number

  the total amount for which the instalment agreement was made

  installmentFee

  number

  the fee charged to consumers for the instalment agreement

  numberOfPaymentsAgreed

  number

  the number of payments that have been agreed

  claimInformation

  object

  currentBalance

  number

  the current balance sum

  currentPrincipalClaim

  number

  the current balance of the claim

  currentInterest

  number

  the current balance of interest

  currentCosts

  number

  the current balance of the costs

  receivedPayments

  number

  the amount of received payments

  claimedAmount

  number

  the amount of the original claim

  currency

  string

  the corresponding currency

  transferDate

  string

  yyyy-MM-dd

  the date when the claim was delivered to the system

  status

  string

  Enum:

  • REJECTED
  • IN_CREATION
  • PROCESSING
  • PAUSED
  • CLOSED

  availableActions

  array

  A set of actions than can be executed on the claim

  jointClaim

  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.

  subClaims

  array

  All additional claims identifier(es) if the searched for claim is the main claim.
• 401 request not authorized
• 404 claim not found