Survey

Create agreement consent from survey

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

personIdintegerRequired

ID of the person

Example: 123

surveyResponseIdintegerOptional

ID of the survey response

Example: 456

agreementTemplateIdintegerOptional

ID of the agreement template

Example: 789

pdfResourceanyOptional

PDF resource as a buffer

Example: <Buffer>

pdfCloudIdsstring[]Optional

Cloud IDs of the PDFs

Example: ["cloud123"]

pdfMimeTypestringOptional

MIME type of the PDF

Example: application/pdf

userActionanyRequired

User action

Default: CREATEExample: CREATE

consumerEpisodeIntakeIdintegerOptional

ID of the consumer episode intake

Example: 101112

attributesobjectOptional

Additional attributes

Default: {}Example: {"key":"value"}

assessmentResponseanyOptional

Response to the assessment

updatedByobjectOptional

User who updated the agreement

Example: {"userId":1}

pdfCloudInfostring[]Optional

Cloud IDs of the PDFs

Example: ["cloud123"]

Responses

200Success

application/json

post

/api/agreements/survey

HTTPcURLJavaScriptPython

POST /api/agreements/survey HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 349

{
  "personId": 123,
  "surveyResponseId": 456,
  "agreementTemplateId": 789,
  "pdfResource": "<Buffer>",
  "pdfCloudIds": [
    "cloud123"
  ],
  "pdfMimeType": "application/pdf",
  "userAction": "CREATE",
  "consumerEpisodeIntakeId": 101112,
  "attributes": {
    "key": "value"
  },
  "data": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "assessmentResponse": {},
  "updatedBy": {
    "userId": 1
  },
  "pdfCloudInfo": [
    "cloud123"
  ]
}

200Success

{
  "id": "12345",
  "agreementTemplateId": 1,
  "surveyResponseId": 1,
  "personId": 1,
  "files": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "resource": null,
      "cloudId": "text",
      "cloudUrl": "text",
      "scanStatus": "text",
      "mimeType": "text",
      "personId": 1,
      "createdAt": "2026-02-06",
      "updatedAt": "2026-02-06",
      "attributes": {},
      "archived": true,
      "healthRecordAttributeFile": [
        {
          "id": 12,
          "fileId": 12,
          "healthRecordAttributeId": 12,
          "notes": "This is example file",
          "createdAt": "2023-03-02 07:14:19.987",
          "updatedAt": "2023-03-02 07:14:19.987"
        }
      ],
      "labels": {},
      "relatedFiles": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "resource": null,
          "cloudId": "text",
          "cloudUrl": "text",
          "scanStatus": "text",
          "mimeType": "text",
          "personId": 1,
          "createdAt": "2026-02-06",
          "updatedAt": "2026-02-06",
          "attributes": {},
          "archived": true,
          "healthRecordAttributeFile": [
            {
              "id": 12,
              "fileId": 12,
              "healthRecordAttributeId": 12,
              "notes": "This is example file",
              "createdAt": "2023-03-02 07:14:19.987",
              "updatedAt": "2023-03-02 07:14:19.987"
            }
          ],
          "labels": {},
          "relatedFiles": [
            "[Circular Reference]"
          ],
          "relatedFile": [
            "[Circular Reference]"
          ],
          "isRelatedFile": true,
          "updatedBy": {},
          "person": {
            "id": 1,
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01",
            "gender": "MALE",
            "mobile": "[phone]",
            "email": "[email protected]",
            "uuid": "uuid-1234",
            "externalId": "external-1234",
            "currency": "USD",
            "consumer": "{}",
            "serviceProvider": "{}"
          }
        }
      ],
      "relatedFile": [
        {
          "id": 1,
          "fromFileId": 1,
          "toFileId": 1,
          "fromFile": {
            "id": 1,
            "name": "text",
            "description": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "personId": 1,
            "createdAt": "2026-02-06",
            "updatedAt": "2026-02-06",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 12,
                "fileId": 12,
                "healthRecordAttributeId": 12,
                "notes": "This is example file",
                "createdAt": "2023-03-02 07:14:19.987",
                "updatedAt": "2023-03-02 07:14:19.987"
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "relatedFile": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {},
            "person": {
              "id": 1,
              "firstName": "John",
              "lastName": "Doe",
              "birthDate": "1990-01-01",
              "gender": "MALE",
              "mobile": "[phone]",
              "email": "[email protected]",
              "uuid": "uuid-1234",
              "externalId": "external-1234",
              "currency": "USD",
              "consumer": "{}",
              "serviceProvider": "{}"
            }
          },
          "toFile": {
            "id": 1,
            "name": "text",
            "description": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "personId": 1,
            "createdAt": "2026-02-06",
            "updatedAt": "2026-02-06",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 12,
                "fileId": 12,
                "healthRecordAttributeId": 12,
                "notes": "This is example file",
                "createdAt": "2023-03-02 07:14:19.987",
                "updatedAt": "2023-03-02 07:14:19.987"
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "relatedFile": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {},
            "person": {
              "id": 1,
              "firstName": "John",
              "lastName": "Doe",
              "birthDate": "1990-01-01",
              "gender": "MALE",
              "mobile": "[phone]",
              "email": "[email protected]",
              "uuid": "uuid-1234",
              "externalId": "external-1234",
              "currency": "USD",
              "consumer": "{}",
              "serviceProvider": "{}"
            }
          },
          "createdAt": "2026-02-06",
          "updatedAt": "2026-02-06"
        }
      ],
      "isRelatedFile": true,
      "updatedBy": {},
      "person": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01",
        "gender": "MALE",
        "mobile": "[phone]",
        "email": "[email protected]",
        "uuid": "uuid-1234",
        "externalId": "external-1234",
        "currency": "USD",
        "consumer": "{}",
        "serviceProvider": "{}"
      }
    }
  ],
  "agreementTemplate": [
    {
      "id": 1,
      "organizationId": 1,
      "name": "Standard Agreement",
      "userAction": "ConsumerOnboarding",
      "contentHtml": "<p>Agreement content here</p>",
      "fields": [],
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  ],
  "surveyResponse": null,
  "person": null,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}