Get fact find | saturn | Documentation

{
  "data": {
    "data": [
      {
        "rows": [
          {
            "id": "56d24c18-b747-4f40-a81f-f3dc357de128",
            "data": {
              "name": "Stocks and Shares ISA",
              "provider": "Vanguard",
              "ownership": "Joint",
              "current_value": "50000"
            },
            "mapped_entity_id": "a41e39c2-37a7-4a87-a18c-2db73a2dc928"
          },
          {
            "id": "a350210a-0a2f-49a3-bc07-daa180efb264",
            "data": {
              "name": "Workplace pension",
              "provider": "Aviva",
              "ownership": "Priya Raman",
              "current_value": "120000"
            },
            "mapped_entity_id": "string"
          }
        ],
        "entity_name": "assets"
      },
      {
        "rows": [
          {
            "id": "6b9cc381-3471-42b5-9574-5734b05cc697",
            "data": {
              "name": "string",
              "provider": "string",
              "ownership": "string",
              "current_value": "string",
              "amount": "75000",
              "frequency": "Annual",
              "owner": "Priya Raman",
              "type": "Salary"
            },
            "mapped_entity_id": "string"
          }
        ],
        "entity_name": "incomes"
      }
    ],
    "meeting_note_id": "6ffa41cd-777d-4a65-88e7-7787fb1ec7da"
  },
  "success": true
}

Returns the fact tables extracted from this meeting note.

data.data is an array of tables. entity_name identifies the financial category, such as assets or incomes. Each row has its extraction id, an optional mapped_entity_id when linked to an existing Saturn record, and a data object containing the extracted fields. Field names vary by category, and all field values are strings.

A 404 means either the note does not belong to your firm or no fact find has been extracted yet. A 502 means a Saturn service is temporarily unavailable. Retry a 502 rather than treating the fact find as absent.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

saturn_ref_idstringRequired

The Saturn UUID for this resource, returned as saturn_ref_id by the corresponding list endpoint.

Response

dataobject

successboolean

erroranyOptional