Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Notes

Create a note

Create a note

post/notes

Request body

contentstring required

The note's text content.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

related_resource_fieldstring

🚧 Beta This is a Beta property. Feedback from the community is welcome. We may make breaking changes to this property. Path to the field in the related resource that the note pertains to. This uses a dot notation like the following: Examples:

  • a field in the resource: first_name
  • a sub-field: legal_address.city
  • nested arrays: application_details.sections[1].pages[2].items[0].answer
related_resource_idstring required

The id of the resource that is associated with the note. This is typically a UUID. For TENANT it is a string tenant ID.

related_resource_type'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER' required

Type of the resource associated with the note.

status'RESOLVED' | 'UNRESOLVED'

The state of the FEEDBACK, use this field to mark fields as RESOLVED or UNRESOLVED. This is required when creating a note with type FEEDBACK. Providing a status with note type NOTE will result in a Bad Request error.

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

type'ACCOUNT_FROZEN' | 'ACCOUNT_SUSPENDED' | 'CUSTOMER_SUSPENDED' | 'FEEDBACK' | 'NOTE'

The type of note.

  • FEEDBACK: User feedback that can be marked resolved/unresolved
  • NOTE: General note
  • ACCOUNT_FROZEN: Automatically created when an account is frozen
  • ACCOUNT_SUSPENDED: Automatically created when an account is suspended
  • CUSTOMER_SUSPENDED: Automatically created when a customer is suspended

Example request

{
  "content": "Customer was frozen to investigate fraud.",
  "related_resource_field": "/legal_address/city",
  "related_resource_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "related_resource_type": "CUSTOMER",
  "status": "RESOLVED",
  "tenant": "abcdef_ghijkl",
  "type": "NOTE"
}

Response

Created note

authorstring required

The note's author.

contentstring required

The note's text content.

creation_timestring date-time required

The date and time the note was created.

idstring uuid required

note ID

last_updated_timestring date-time required

The date and time the note was last updated.

metadataMetadata

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

related_resource_fieldstring

🚧 Beta This is a Beta property. Feedback from the community is welcome. We may make breaking changes to this property. Path to the field in the related resource that the note pertains to. This uses a dot notation like the following: Examples:

  • a field in the resource: first_name
  • a sub-field: legal_address.city
  • nested arrays: application_details.sections[1].pages[2].items[0].answer
related_resource_idstring required

The id of the resource that is associated with the note. This is typically a UUID. For TENANT it is a string tenant ID.

related_resource_type'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER' required

Type of the resource associated with the note.

status'RESOLVED' | 'UNRESOLVED'

The state of the FEEDBACK, use this field to mark fields as RESOLVED or UNRESOLVED. This is required when creating a note with type FEEDBACK. Providing a status with note type NOTE will result in a Bad Request error.

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

type'ACCOUNT_FROZEN' | 'ACCOUNT_SUSPENDED' | 'CUSTOMER_SUSPENDED' | 'FEEDBACK' | 'NOTE'

The type of note.

  • FEEDBACK: User feedback that can be marked resolved/unresolved
  • NOTE: General note
  • ACCOUNT_FROZEN: Automatically created when an account is frozen
  • ACCOUNT_SUSPENDED: Automatically created when an account is suspended
  • CUSTOMER_SUSPENDED: Automatically created when a customer is suspended

Example response

{
  "author": "Jane Smith jane@example.com",
  "content": "Customer was frozen to investigate fraud.",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "related_resource_field": "/legal_address/city",
  "related_resource_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "related_resource_type": "CUSTOMER",
  "status": "RESOLVED",
  "tenant": "abcdef_ghijkl",
  "type": "NOTE"
}