Uploading Prepared Data

Some workflows accept raw data values that identify the end user. Your integration needs to capture this data and upload it as a credential type called Prepared Data. The account response includes an object in the credentials array with a category of DATA and an api object with:

  • A token value for authorizing the upload.

  • A parts object with a prepared_data value that is the URL to upload the data.

Use a POST request and provide the values as a JSON. See the PREPARED_DATA endpoint description in: Credentials API Reference.

Example: Prepared Data Credential Object in Account Response

"credentials": [
  {
    "id": "e62dc87d-bc8a-4933-8ace-05acc3c8a379",
    "category": "DATA",
    "allowedChannels": [
      "API"
    ],
    "api": {
      "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XLOQ4CMQxA0bukxpIztmOHDlHRcoM4S8dSIMEIcXfC3ID26_136K_DI-xD1IjEiTQtbGEXSq2nNvuIWYh6g84ygBMqGBICC0fLtXlvG99wwahKlSC5T-LI4KQEKshuTQiXNvFz9H94Pfcx9WU93i73cl1_afuzpGicGhThPn9DMFsQSkZXZS8x1_D5AkAD7yrjAAAA.2qBHxwy43HMorgyrnL2AUOP_igbBNplBg8ZX9U-MeoPPek4mHTf_C4E9Ubbx4qehkyahdskiK1CCkLChrfqNpA",
      "parts": {
        "prepared_data": "https://api.amer-1.jumio.ai/api/v1/accounts/f19533ed-e45f-4607-8030-454189cdbed8/workflow-executions/a01773c3-6bb0-4b04-b373-7504b8d5302d/credentials/e62dc87d-bc8a-4933-8ace-05acc3c8a379/parts/PREPARED_DATA"
      },
      "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/f19533ed-e45f-4607-8030-454189cdbed8/workflow-executions/a01773c3-6bb0-4b04-b373-7504b8d5302d"
    }
  }
]

See also: Capabilities Reference.