Consumerportal Collection

The consumerportal collection has a set of endpoints which provide all neccesary information about the consumers’ dossier. This also includes information about their products and productactions.

getSession

GET /consumerportal/getsession

This endpoint returns all the information about the consumers dossier.

Request

This request require these parameters:

Parameter Type Required Description
consumer_id string Yes Consumer id
ip_address string Yes IP address of the consumer using the portal

Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
{
  "consumerportalsession": {
    "session": {
      "date_started": "2018-01-01 12:00:00",
      "session_id": "ok1t1s26ecft711b72tlkjoae0",
      "state": "RUNNING"
    },
    "dossier": {
      "id": "DS86CE093EB31D131449DCABEBB7C39F",
      "code": "TEST-1",
      "date_created": "2018-01-01",
      "owner": {
        "name": "Testgebruiker",
        "phone": "0570 665 144",
        "emailaddress": "sample@bwss.nl",
        "avatar_base64": null
      },
      "advisor": {
        "name": "Testgebruiker",
        "phone": "0570 665 144",
        "emailaddress": "sample@bwss.nl",
        "avatar_base64": null
      },
      "products": {
        "PRFE1A72620E23AC13009D2287C6B864": {
          "id": "PRFE1A72620E23AC13009D2287C6B864",
          "type": "MORTGAGE",
          "label": "SNS Budget Hypotheek",
          "reference_number": "TEST-1-M-ea66c06c1e1c05fa9f1aa39d98dc5bc1",
          "quote_number": "",
          "mortgage": {
            "label": "SNS Budget Hypotheek",
            "arrangement": null,
            "mortgage_amount": null,
            "lender_name": "SNS Bank",
            "has_timeline": true,
            "rendered_timeline": "<div class=\"container-fluid\"></div>"
          },
          "productaction_counters": {
            "total": 1,
            "done": 1
          },
          "productactions": {
            "PRA433FB8570F2C0F6D816F1A0A283BFE": {
              "id": "PRA433FB8570F2C0F6D816F1A0A283BFE",
              "date_created": "2018-01-01",
              "date_executed": "2018-01-01",
              "is_done": 1,
              "type": "UPLOAD_DOCUMENTMANAGEMENT_FILE",
              "comment": "",
              "label": "Aanleveren van geldig legitimatiebewijs (Jan Janssen)",
              "product_id": "PRFE1A72620E23AC13009D2287C6B864",
              "document": {
                "upload_requirements": [
                  "Paspoort opengevouwen met beide pagina's in beeld",
                  "Europese Identiteitskaart, kopie op ware grootte van de voor- en achterzijde."
                ],
                "label": "Geldig legitimatiebewijs (Paspoort of Europese Identiteitskaart)",
                "description": "",
                "is_consumer_specific": true,
                "consumer_name": "Jan Janssen"
              }
            }
          }
        }
      },
      "consumer": {
        "id": "CNSR22966DC6C1D2E53D861B2794F6A20E",
        "gender": "M",
        "initials": null,
        "firstname": "Jan",
        "prefix": "",
        "surname": "Janssen",
        "display_name": "Jan Janssen",
        "streetname": "Herfordstraat",
        "housenumber": "8",
        "housenumber_addition": null,
        "date_of_birth": null,
        "zipcode": "7418EX",
        "city": "Deventer",
        "phone": "0570 665 144",
        "phone_mobile": null,
        "emailaddress": "j.janssen@freeler.nl"
      }
    },
    "duplicate_comfort_data": {
      "downloadable_productactions": [
      ],
      "uploadable_productactions": {
        "PRA433FB8570F2C0F6D816F1A0A283BFE": {
          "id": "PRA433FB8570F2C0F6D816F1A0A283BFE",
          "date_created": "2018-01-01",
          "date_executed": "2018-01-01",
          "is_done": 1,
          "type": "UPLOAD_DOCUMENTMANAGEMENT_FILE",
          "comment": "",
          "label": "Aanleveren van geldig legitimatiebewijs",
          "product_id": "PRFE1A72620E23AC13009D2287C6B864",
          "document": {
            "upload_requirements": [
              "Paspoort opengevouwen met beide pagina's in beeld",
              "Europese Identiteitskaart, kopie op ware grootte"
            ],
            "label": "Geldig legitimatiebewijs",
            "description": "",
            "is_consumer_specific": true,
            "consumer_name": "Jan Janssen"
          }
        }
      },
      "actioncounter_total": {
        "total": 1,
        "done": 1
      },
      "actioncounter_per_product": {
        "PRFE1A72620E23AC13009D2287C6B864": {
          "total": 1,
          "done": 1
        }
      },
      "most_recent_appointment": false,
      "productactions": {
        "PRA433FB8570F2C0F6D816F1A0A283BFE": {
          "id": "PRA433FB8570F2C0F6D816F1A0A283BFE",
          "date_created": "2018-01-01",
          "date_executed": "2018-01-01",
          "is_done": 1,
          "type": "UPLOAD_DOCUMENTMANAGEMENT_FILE",
          "comment": "",
          "label": "Aanleveren van geldig legitimatiebewijs (Jan Janssen)",
          "product_id": "PRFE1A72620E23AC13009D2287C6B864",
          "document": {
            "upload_requirements": [
              "Paspoort opengevouwen met beide pagina's in beeld",
              "Europese Identiteitskaart, kopie op ware grootte"
            ],
            "label": "Geldig legitimatiebewijs",
            "description": "",
            "is_consumer_specific": true,
            "consumer_name": "Jan Janssen"
          }
        }
      }
    }
  }
}

getProductActionDownload

GET /consumerportal/get_product_action_download

This endpoint will return a document associated with the product action.

Request

Parameter Type Required Description
productaction_id string Yes Product action id (found in getSession request)

Response

1
2
3
4
5
Content-Type: application/pdf
Content-Length: 1024
Content-Disposition: attachment; filename="demo.pdf"

<file_blob>

uploadFile

POST /consumerportal/upload_file

With this endpoint you can upload a file to accelerate.

Note

This endpoint is an upload type, which means that parameters are sent as header, see Available request methods

Warning

This request can be fired only once per product action or it needs to be a reupload

Request

Parameter Type Required Description
productaction_id string Yes For which product action is this file for
is_reupload int(1) Yes Whenever this action is a reupload or not (1 = True, 0 = False)
filename string Yes The filename of the uploaded file
mimetype string Yes The mimetype of the uploaded file
comment string No A comment placed by the consumer about the file

Response

1
2
3
{
  "operation_result" : "ok"
}

getOtdPdf

GET /consumerportal/get_otd_pdf

Get the pdf of an OTD document.

Request

Parameter Type Required Description
productaction_id string Yes Product action id (found in getSession request)

Response

1
2
3
4
{
  "raw_pdf_data" : "<base64_encoded pdf blob>",
  "filename" : "otd.pdf"
}

signOtd

POST /consumerportal/sign_otd

Signs an OTD in name of the logged in consumer. This is a digital sign.

Request

Parameter Type Required Description
productaction_id string Yes Product action id (found in getSession request)

Response

1
2
3
{
  "operation_result" : "ok"
}