Acceptance Document Object

The Acceptance Document object represents a Customer’s agreement to a legal document, such as a privacy policy or a terms and conditions agreement.

Attributes

documentId

string

Semantic document ID. Identifies the type of acceptance document (example: kor-privacy-policy).

documentVersion

string

Semantic document version. Identifies the version number of the acceptance document.

acceptorType

string enum, values: CUSTOMER, EMPLOYEE, SERVICE_ACCOUNT

Type of entity that agreed to the acceptance document. The following values are supported:

CUSTOMER RocketKOR Customer Account.
EMPLOYEE Team Member using the RocketKOR Portal.
SERVICE_ACCOUNT Service Account using APIs.

acceptorId

string (UUID)

ID of the entity that agreed to the acceptance document.

businessAccountId

string (UUID)

Business Account ID.

scopes

string

Any scopes that limit the acceptance document. For example, the document may only be valid for a specific Financial Account. Scopes are shown as key/value pairs.

metadata

string

Key/value pairs with additional information about the acceptance document.

accepted

boolean

Whether the Customer has agreed to the acceptance document.

Has the value true if the Customer has agreed to the document.
Has the value false if the Customer has rejected the document.

respondedAt

string (date-time)

Date and time the Customer accepted or rejeced the document.

string (UUID)

ID of the acceptance document record.

createdBy

object

Entity that created the acceptance document record.

string (UUID)

ID of the entity. Will be blank if created.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the acceptance document record was created in the RocketKOR system.

downloadUrl

string (URI)

Content URL for the acceptance document. This URL can be used to download the document.

Acceptance Document Object

				
					{
  "documentId": "kor-privacy-policy",
  "documentVersion": "v1.2-4b",
  "acceptorType": "CUSTOMER",
  "acceptorId": "4a7c193e-b571-4ae0-80a3-a1a54dbec926",
  "businessAccountId": "d255a08d-8d98-41b6-b1d5-6db5aadc6461",
  "scopes": {
    "FINANCIAL_ACCOUNT_ID": "574bb046-7257-4bb4-b45b-c68974e3ea9e"
  },
  "metadata": {
    "key1": "value1",
    "key2": "value2",
  },
  "accepted": true,
  "respondedAt": "2023-08-15T18:26:57.953Z",
  "id": "9c722ece-1f71-4e2f-87d9-38c903603152",
  "createdBy": {
    "id": "f7055c44-e1ca-4e51-876b-6f8365fffd98",
    "type": "employee"
  },
  "createdAt": "2023-08-15T18:26:57.953Z",
  "downloadUrl": "https://documents.rocketkor.net/api/download/v1/documents/acceptance/privacy-policy?docVersion=1.1.1"
}