Request missing user data fields

Requests missing profile/data fields from a user. Scoped to your integration’s institution via Basic Auth credentials.

POST/users/{id}/data-collection-requests

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Request body

requiredapplication/json

fieldsDataCollectionFieldSpec[]required

Show properties

Array of DataCollectionFieldSpec

fieldTypestringrequired

Allowed:CUSTOMPERSONALSTATISTIC

customFieldIdstring | null

hardcodedFieldstring | null

sendNotificationboolean

default: false

Responses

201

Data collection request created

dataobjectrequired

Show properties

userIdstringrequired

createdintegerrequired

notifiedbooleanrequired

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

404

Not Found

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://fuxam.app/api/v4/users/string/data-collection-requests' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "fields": [
    {
      "fieldType": "CUSTOM",
      "customFieldId": "clxfield1234",
      "hardcodedField": null
    },
    {
      "fieldType": "PERSONAL",
      "customFieldId": null,
      "hardcodedField": "dateOfBirth"
    }
  ],
  "sendNotification": true
}'

const response = await fetch("https://fuxam.app/api/v4/users/string/data-collection-requests", {
  method: "POST",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"fields\": [\n    {\n      \"fieldType\": \"CUSTOM\",\n      \"customFieldId\": \"clxfield1234\",\n      \"hardcodedField\": null\n    },\n    {\n      \"fieldType\": \"PERSONAL\",\n      \"customFieldId\": null,\n      \"hardcodedField\": \"dateOfBirth\"\n    }\n  ],\n  \"sendNotification\": true\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/users/string/data-collection-requests",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"fields\": [\n    {\n      \"fieldType\": \"CUSTOM\",\n      \"customFieldId\": \"clxfield1234\",\n      \"hardcodedField\": null\n    },\n    {\n      \"fieldType\": \"PERSONAL\",\n      \"customFieldId\": null,\n      \"hardcodedField\": \"dateOfBirth\"\n    }\n  ],\n  \"sendNotification\": true\n}",
)

Response

{
  "data": {
    "userId": "string",
    "created": 0,
    "notified": true
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}