Utilities
resourcesopenapi-utilities.json
{
"components": {
"securitySchemes": {
"apiKey": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http"
},
"basicAuth": {
"scheme": "basic",
"type": "http"
}
}
},
"info": {
"contact": {
"email": "[email protected]",
"name": "Treasury Prime Support",
"url": "https://support.treasuryprime.com"
},
"summary": "Banking APIs",
"termsOfService": "https://www.treasuryprime.com/policy/terms",
"title": "Utilities",
"version": "1.16.137-gec7bd54b"
},
"openapi": "3.1.0",
"paths": {
"/document": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"bankdata": {
},
"created_at": "2021-03-25T21:31:50Z",
"fields": {
"date_of_birth": "1980-03-15"
},
"file_id": "file_567890",
"id": "doc_123456",
"name": "California Drivers License",
"type": "drivers_license",
"updated_at": "2021-03-25T21:31:50Z",
"userdata": {
}
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"bank_id": {
"description": "ID of the bank with which the object is associated",
"type": "string"
},
"bankdata": {
"description": "Optional arbitrary data the bank can attach to the object",
"type": "object"
},
"description": {
"deprecated": true,
"description": "Description (deprecated)",
"type": "string"
},
"fields": {
"description": "Object representing the data encoded in the Document",
"type": "object"
},
"file_id": {
"description": "The unique ID for an attached File",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"name": {
"description": "A descriptive name for the document",
"type": "string"
},
"org_id": {
"description": "ID of the organization with which the object is associated",
"type": "string"
},
"type": {
"description": "One of: `drivers_license`, `military_id`, `passport`, `state_id`, `other`",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary data the user can attach to the object",
"type": "object"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of document elements"
}
},
"summary": "List Documents",
"tags": [
"Document"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Example",
"value": {
"fields": {
"date_of_birth": "1980-03-15"
},
"file_id": "file_567890",
"name": "California Drivers License",
"type": "drivers_license"
}
}
},
"schema": {
"properties": {
"bankdata": {
"description": "Optional arbitrary data the bank can attach to the object",
"type": "object"
},
"fields": {
"description": "Object representing the data encoded in the Document",
"type": "object"
},
"file_id": {
"description": "The unique ID for an attached File",
"type": "string"
},
"name": {
"description": "A descriptive name for the document",
"type": "string"
},
"type": {
"description": "One of: `drivers_license`, `military_id`, `passport`, `state_id`, `other`",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary data the user can attach to the object",
"type": "object"
}
},
"required": [
"type",
"id"
]
}
}
},
"description": "The document to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"bankdata": {
},
"created_at": "2021-03-25T21:31:50Z",
"fields": {
"date_of_birth": "1980-03-15"
},
"file_id": "file_567890",
"id": "doc_123456",
"name": "California Drivers License",
"type": "drivers_license",
"updated_at": "2021-03-25T21:31:50Z",
"userdata": {
}
}
}
},
"schema": {
"properties": {
"bank_id": {
"description": "ID of the bank with which the object is associated",
"type": "string"
},
"bankdata": {
"description": "Optional arbitrary data the bank can attach to the object",
"type": "object"
},
"description": {
"deprecated": true,
"description": "Description (deprecated)",
"type": "string"
},
"fields": {
"description": "Object representing the data encoded in the Document",
"type": "object"
},
"file_id": {
"description": "The unique ID for an attached File",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"name": {
"description": "A descriptive name for the document",
"type": "string"
},
"org_id": {
"description": "ID of the organization with which the object is associated",
"type": "string"
},
"type": {
"description": "One of: `drivers_license`, `military_id`, `passport`, `state_id`, `other`",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary data the user can attach to the object",
"type": "object"
}
}
}
}
},
"description": "The document created"
}
},
"summary": "Create a Document",
"tags": [
"Document"
]
}
},
"/document/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"bankdata": {
},
"created_at": "2021-03-25T21:31:50Z",
"fields": {
"date_of_birth": "1980-03-15"
},
"file_id": "file_567890",
"id": "doc_123456",
"name": "California Drivers License",
"type": "drivers_license",
"updated_at": "2021-03-25T21:31:50Z",
"userdata": {
}
}
}
},
"schema": {
"properties": {
"bank_id": {
"description": "ID of the bank with which the object is associated",
"type": "string"
},
"bankdata": {
"description": "Optional arbitrary data the bank can attach to the object",
"type": "object"
},
"description": {
"deprecated": true,
"description": "Description (deprecated)",
"type": "string"
},
"fields": {
"description": "Object representing the data encoded in the Document",
"type": "object"
},
"file_id": {
"description": "The unique ID for an attached File",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"name": {
"description": "A descriptive name for the document",
"type": "string"
},
"org_id": {
"description": "ID of the organization with which the object is associated",
"type": "string"
},
"type": {
"description": "One of: `drivers_license`, `military_id`, `passport`, `state_id`, `other`",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary data the user can attach to the object",
"type": "object"
}
}
}
}
},
"description": "The document"
}
},
"summary": "Fetch a Document",
"tags": [
"Document"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Updating name",
"value": {
"name": "OR Drivers License"
}
}
},
"schema": {
"properties": {
"bankdata": {
"description": "Optional arbitrary data the bank can attach to the object",
"type": "object"
},
"fields": {
"description": "Object representing the data encoded in the Document",
"type": "object"
},
"name": {
"description": "A descriptive name for the document",
"type": "string"
},
"type": {
"description": "One of: `drivers_license`, `military_id`, `passport`, `state_id`, `other`",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary data the user can attach to the object",
"type": "object"
}
}
}
}
},
"description": "The document to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"bankdata": {
},
"created_at": "2021-03-25T21:31:50Z",
"fields": {
"date_of_birth": "1980-03-15"
},
"file_id": "file_567890",
"id": "doc_123456",
"name": "OR Drivers License",
"type": "drivers_license",
"updated_at": "2021-03-25T21:31:50Z",
"userdata": {
}
}
}
},
"schema": {
"properties": {
"bank_id": {
"description": "ID of the bank with which the object is associated",
"type": "string"
},
"bankdata": {
"description": "Optional arbitrary data the bank can attach to the object",
"type": "object"
},
"description": {
"deprecated": true,
"description": "Description (deprecated)",
"type": "string"
},
"fields": {
"description": "Object representing the data encoded in the Document",
"type": "object"
},
"file_id": {
"description": "The unique ID for an attached File",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"name": {
"description": "A descriptive name for the document",
"type": "string"
},
"org_id": {
"description": "ID of the organization with which the object is associated",
"type": "string"
},
"type": {
"description": "One of: `drivers_license`, `military_id`, `passport`, `state_id`, `other`",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary data the user can attach to the object",
"type": "object"
}
}
}
}
},
"description": "The document updated"
}
},
"summary": "Update a Document",
"tags": [
"Document"
]
}
},
"/file/{id}": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"content_hash": "5644a65d2e0adb879329196d8e115be52e2a921c",
"content_length": 347504,
"content_type": "image/jpeg",
"content_url": "https://treasuryprime-usercontent.com/sandbox/org_1he97gra9he/0/5644...",
"created_at": "2023-11-16T22:59:31Z",
"id": "file_11jnd0n3nx",
"updated_at": "2023-11-16T22:59:31Z"
}
]
}
}
},
"schema": {
"properties": {
"content_hash": {
"description": "SHA-1 hash of the file contents",
"type": "string"
},
"content_length": {
"description": "Length of the file contents in bytes",
"type": "integer"
},
"content_type": {
"description": "A valid media type",
"type": "string"
},
"content_url": {
"description": "A url that can be used to download the file. URL is only valid for a short time",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
}
}
}
}
},
"description": "The file"
}
},
"summary": "Fetch a File",
"tags": [
"File"
]
}
},
"/file/{id}/content": {
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
},
"schema": {
"properties": {
"content_hash": {
"description": "SHA-1 hash of the file contents",
"type": "string"
},
"content_length": {
"description": "Length of the file contents in bytes",
"type": "integer"
},
"content_type": {
"description": "A valid media type",
"type": "string"
},
"content_url": {
"description": "A url that can be used to download the file. URL is only valid for a short time",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
}
}
}
}
},
"description": "The file"
}
},
"summary": "Download a File",
"tags": [
"File"
]
}
},
"/routing_number/{routing_number}": {
"get": {
"parameters": [
{
"description": "The routing number of the bank. Filterable.",
"in": "path",
"name": "routing_number",
"required": true,
"schema": {
"description": "The routing number of the bank. Filterable.",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"ach": true,
"bank_name": "FEDERAL RESERVE BANK OF BOSTON",
"bank_short_name": "FRB-BOS",
"city": "BOSTON",
"created_at": "2021-11-12T18:48:27Z",
"routing_number": "011000015",
"state": "MA",
"updated_at": "2021-11-12T18:48:27Z",
"wire": true
}
}
},
"schema": {
"properties": {
"ach": {
"description": "Whether the routing number processes FedACH payments",
"type": "boolean"
},
"bank_name": {
"description": "The name of the bank",
"type": "string"
},
"bank_short_name": {
"description": "The short-form name of the bank",
"type": "string"
},
"city": {
"description": "City",
"type": "string"
},
"created_at": {
"description": "Timestamp of when this Routing Number object was added to Treasury Prime's records",
"type": "string"
},
"routing_number": {
"description": "The routing number of the bank. Filterable.",
"type": "string"
},
"state": {
"description": "State",
"type": "string"
},
"updated_at": {
"description": "Timestamp of the last object update",
"type": "string"
},
"wire": {
"description": "Whether the routing number processes FedWire payments",
"type": "boolean"
}
}
}
}
},
"description": "The routing-number"
}
},
"summary": "Fetch a Routing Number",
"tags": [
"Routing Number"
]
}
},
"/search": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"created_at": "2018-11-09T16:53:05Z",
"object_id": "apsn_11eprxk81zvvz",
"object_type": "apply_person_application",
"related": {
"apply_account_application_id": "aact_11eprxk28zvw4"
},
"updated_at": "2018-11-09T16:53:05Z"
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"object_id": {
"description": "ID of the object that was found",
"type": "string"
},
"object_type": {
"description": "Type of the object that was found",
"type": "string"
},
"related": {
"description": "Related data (dependent on the object_type)",
"type": "object"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of search elements"
}
},
"summary": "Search",
"tags": [
"Search"
]
}
},
"/webhook": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"data": [
{
"basic_secret": null,
"basic_user": "organization_name",
"created_at": "2018-12-03T19:46:45Z",
"error": null,
"event": "ach.update",
"id": "wh_012345678923",
"status": "enabled",
"updated_at": "2018-12-03T19:46:45Z",
"url": "https://example.application.com/notify",
"userdata": null
}
]
}
}
},
"schema": {
"properties": {
"data": {
"items": {
"properties": {
"basic_secret": {
"description": "Second value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation. This will appear as null in all responses, for security.",
"type": "string"
},
"basic_user": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"error": {
"description": "The error reason, if the webhook has transitioned status to `error`",
"type": "string"
},
"event": {
"description": "The event to listen for. [Available events](/reference/webhook-events)",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"status": {
"description": "One of `enabled`, `disabled`, or `error`. Filterable.",
"type": "string"
},
"url": {
"description": "The HTTPS URL where the event notification will be sent",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary user data",
"type": "object"
}
}
},
"type": "array"
},
"description": "Array of objects"
},
"type": "object"
}
}
},
"description": "A list of webhook elements"
}
},
"summary": "List Webhooks",
"tags": [
"Webhook"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"basic_secret": "secret",
"basic_user": "organization_name",
"event": "ach.update",
"url": "https://example.application.com/notify"
}
}
},
"schema": {
"properties": {
"basic_secret": {
"description": "Second value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation. This will appear as null in all responses, for security.",
"type": "string"
},
"basic_user": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"event": {
"description": "The event to listen for. [Available events](/reference/webhook-events)",
"type": "string"
},
"url": {
"description": "The HTTPS URL where the event notification will be sent",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary user data",
"type": "object"
}
},
"required": [
"event",
"id",
"url"
]
}
}
},
"description": "The webhook to create",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"basic_secret": null,
"basic_user": "organization_name",
"created_at": "2018-12-03T19:46:45Z",
"error": null,
"event": "ach.update",
"id": "wh_012345678923",
"status": "enabled",
"updated_at": "2018-12-03T19:46:45Z",
"url": "https://example.application.com/notify",
"userdata": null
}
}
},
"schema": {
"properties": {
"basic_secret": {
"description": "Second value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation. This will appear as null in all responses, for security.",
"type": "string"
},
"basic_user": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"error": {
"description": "The error reason, if the webhook has transitioned status to `error`",
"type": "string"
},
"event": {
"description": "The event to listen for. [Available events](/reference/webhook-events)",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"status": {
"description": "One of `enabled`, `disabled`, or `error`. Filterable.",
"type": "string"
},
"url": {
"description": "The HTTPS URL where the event notification will be sent",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary user data",
"type": "object"
}
}
}
}
},
"description": "The webhook created"
}
},
"summary": "Create a Webhook",
"tags": [
"Webhook"
]
}
},
"/webhook/{id}": {
"delete": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
}
},
"summary": "Delete a Webhook",
"tags": [
"Webhook"
]
},
"get": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"basic_secret": null,
"basic_user": "organization_name",
"created_at": "2018-12-03T19:46:45Z",
"error": null,
"event": "ach.update",
"id": "wh_012345678923",
"status": "enabled",
"updated_at": "2018-12-03T19:46:45Z",
"url": "https://example.application.com/notify",
"userdata": null
}
}
},
"schema": {
"properties": {
"basic_secret": {
"description": "Second value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation. This will appear as null in all responses, for security.",
"type": "string"
},
"basic_user": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"error": {
"description": "The error reason, if the webhook has transitioned status to `error`",
"type": "string"
},
"event": {
"description": "The event to listen for. [Available events](/reference/webhook-events)",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"status": {
"description": "One of `enabled`, `disabled`, or `error`. Filterable.",
"type": "string"
},
"url": {
"description": "The HTTPS URL where the event notification will be sent",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary user data",
"type": "object"
}
}
}
}
},
"description": "The webhook"
}
},
"summary": "Fetch a Webhook",
"tags": [
"Webhook"
]
},
"patch": {
"parameters": [
{
"description": "Unique identifier for object",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Unique identifier for object",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"basic_secret": "secret",
"basic_user": "organization_name",
"url": "https://example.application.com/newurl"
}
}
},
"schema": {
"properties": {
"basic_secret": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"basic_user": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"event": {
"description": "The event to listen for. [Available events](/reference/webhook-events)",
"type": "string"
},
"status": {
"description": "One of `enabled` or `disabled`",
"type": "string"
},
"url": {
"description": "The HTTPS URL where the event notification will be sent",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary user data",
"type": "object"
}
}
}
}
},
"description": "The webhook to update",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"example": {
"summary": "Success",
"value": {
"basic_secret": null,
"basic_user": "organization_name",
"created_at": "2018-12-03T19:46:45Z",
"error": null,
"event": "ach.update",
"id": "wh_012345678923",
"status": "enabled",
"updated_at": "2018-12-03T19:46:45Z",
"url": "https://example.application.com/newurl",
"userdata": null
}
}
},
"schema": {
"properties": {
"basic_secret": {
"description": "Second value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation. This will appear as null in all responses, for security.",
"type": "string"
},
"basic_user": {
"description": "First value in `base64(basic_user:basic_secret)`, sent as `Authorization` for request validation",
"type": "string"
},
"error": {
"description": "The error reason, if the webhook has transitioned status to `error`",
"type": "string"
},
"event": {
"description": "The event to listen for. [Available events](/reference/webhook-events)",
"type": "string"
},
"id": {
"description": "Unique identifier for object",
"type": "string"
},
"status": {
"description": "One of `enabled`, `disabled`, or `error`. Filterable.",
"type": "string"
},
"url": {
"description": "The HTTPS URL where the event notification will be sent",
"type": "string"
},
"userdata": {
"description": "Optional arbitrary user data",
"type": "object"
}
}
}
}
},
"description": "The webhook updated"
}
},
"summary": "Update a Webhook",
"tags": [
"Webhook"
]
}
}
},
"security": [
{
"basicAuth": []
},
{
"apiKey": []
}
],
"servers": [
{
"description": "Production",
"url": "https://api.treasuryprime.com"
},
{
"description": "Sandbox",
"url": "https://api.sandbox.treasuryprime.com"
}
]
}Updated 7 days ago