Get relationship options

GET /api/v2/clients/relationships/options
Bearer auth

This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data object
      Hide data attribute Show data attribute object
      • RelationshipID object
        Hide RelationshipID attributes Show RelationshipID attributes object
        • 1 string
        • 2 string
        • 3 string
        • 4 string
        • 5 string
        • 6 string
        • 7 string
        • 8 string
        • 9 string
        • 10 string
        • 11 string
GET /api/v2/clients/relationships/options 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/clients/relationships/options' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "RelationshipID": {
      "1": "Spouse Spouse",
      "2": "Partner Partner",
      "3": "Parent Child",
      "4": "Child Parent",
      "5": "Sibling Sibling",
      "6": "Friend Friend",
      "7": "Business Colleague Business Colleague",
      "8": "GrandChild GrandParent",
      "9": "GrandParent GrandChild",
      "10": "In a Household In a Household",
      "11": "Civil Partner Civil Partner"
    }
  }
}