Notes Administration v0.1.2

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Manage text notes and attachments, associated with a resource within banking administration. Each note has plain text content of up to 400 characters, and an array of up to 8 attachments. Notes are mostly immutable, although a note creator can delete attachments.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/bankingAdmin

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based client identification. See details at Secure Access.

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Schemas

adminNote

{
  "id": "0399abed-fd3d",
  "text": "Please review this fraud report.",
  "createdAt": "2023-04-19T10:49:28.375Z",
  "creator": {
    "id": "0399abed-fd3d",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings",
    "state": "active"
  },
  "attachments": [
    {
      "id": "0399abed-fd3d",
      "name": "fraud-report-389398.pdf",
      "contentType": "application/pdf",
      "url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
      "contentLength": 276000
    }
  ],
  "context_url": "https://production.api.apiture.com/dao/accountApplications/applications/c595c7f85ab257a063bc"
}

Admin Note (v1.0.1)

Representation of admin note resources.

Properties

adminNoteAttachmentItem

{
  "id": "0399abed-fd3d",
  "name": "fraud-report-389398.pdf",
  "contentType": "application/pdf",
  "url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
  "contentLength": 276000
}

Admin Note Attachment Item (v1.0.0)

Summary representation of an admin note attachment in a list of admin note attachments.

Properties

adminNoteContentType

"text/plain"

Admin Note Content Type (v1.0.0)

The list of allowed content types for admin notes.

type: string

enum values: text/plain, image/bmp, image/gif, image/png, image/jpeg, image/tiff, application/msword, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document

adminNoteContext_url

"../dictionary"

Admin Note Context URI (v1.0.0)

Identifies a resource or other context that the note is associated with. For example, to associate a note with an account application, use the application resource's URI.

type: string(uri-reference)

format: uri-reference
maxLength: 2048

adminNoteItem

{
  "id": "0399abed-fd3d",
  "text": "Please review this fraud report.",
  "createdAt": "2023-04-19T10:49:28.375Z",
  "creator": {
    "id": "0399abed-fd3d",
    "firstName": "Benny",
    "lastName": "Billings",
    "username": "bbillings",
    "state": "active"
  },
  "attachments": [
    {
      "id": "0399abed-fd3d",
      "name": "fraud-report-389398.pdf",
      "contentType": "application/pdf",
      "url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
      "contentLength": 276000
    }
  ]
}

Admin Note Item (v1.0.1)

Summary representation of an admin note resource in admin notes collections. To fetch the full representation of this admin note, use the getAdminNote operation, passing this item's id field as the adminNoteId path parameter.

Properties

adminNotes

{
  "context_url": "https://production.api.apiture.com/dao/accountApplications/applications/c595c7f85ab257a063bc",
  "items": [
    {
      "id": "0399abed-fd3d",
      "text": "Please review this fraud report.",
      "createdAt": "2023-04-19T10:48:28.375Z",
      "creator": {
        "id": "0399abed-fd3d",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings",
        "state": "active"
      },
      "attachments": [
        {
          "id": "0399abed-fd3d",
          "name": "fraud-report-389398.pdf",
          "contentType": "application/pdf",
          "url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
          "contentLength": 276000
        }
      ]
    },
    {
      "id": "0399abed-fd3d",
      "text": "Thanks!",
      "createdAt": "2023-04-19T10:50:04.375Z",
      "creator": {
        "id": "0399abed-fd3d",
        "firstName": "Benny",
        "lastName": "Billings",
        "username": "bbillings",
        "state": "active"
      }
    }
  ]
}

Admin Note Collection (v1.0.1)

Collection of admin notes. The items in the collection are ordered in the items array.

Properties

adminUserReference

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings",
  "state": "active"
}

Admin User Reference (v1.0.0)

A small object representing an administrative user's login account.

Properties

adminUserState

"active"

Admin User State (v1.0.0)

The current state of the admin user.

adminUserState strings may have one of the following enumerated values:

type: string

enum values: active, locked, removed

newAdminNote

{
  "text": "Please review this fraud report.",
  "context_url": "https://production.api.apiture.com/dao/accountApplications/applications/c595c7f85ab257a063bc",
  "attachments": [
    {
      "id": "79e2721877a865eaeaf7",
      "contentType": "application/pdf",
      "url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
      "name": "fraud-report-489fjk.pdf"
    }
  ]
}

New Admin Note (v1.0.0)

Request body to create a new admin note. The attachments, if any, refer to documents the client has previously uploaded to a shared document store.

Properties

newAdminNoteAttachment

{
  "contentType": "application/pdf",
  "url": "https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf",
  "name": "fraud-report-489fjk.pdf"
}

New Admin Note Attachment (v1.0.0)

An attachment to associate with this new admin note. The user must first upload the attachment via a document storage service and include the URL of the document here.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"