Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.s.unit.sh
/counterparties/{counterpartyId}
Delete Counterparty via API
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| counterpartyId | path | required | string | ID of the counterparty to delete |
Successful Response
DELETE /counterparties/{counterpartyId}
/users/{userId}/api-tokens/{tokenId}
Get a Reward from API
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | ID of the user to revoke token |
| tokenId | path | required | string | ID of the token to revoke |
Successful Response
DELETE /users/{userId}/api-tokens/{tokenId}
/stop-payments/{stop_payment_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| stop_payment_id | path | required | string | ID of the stop payment |
Stop payment successfully canceled
Stop payment not found
DELETE /stop-payments/{stop_payment_id}
ApproveAuthorizationRequestByIdRequest
{
"type": "object",
"title": "ApproveAuthorizationRequest",
"properties": {
"data": {
"$ref": "#/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/approveAuthorizationRequest"
}
}
}
ApproveAuthorizationRequestByIdResponse
{
"type": "object",
"title": "UnitAuthorizationRequestResponse",
"properties": {
"data": {
"$ref": "#/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
ApproveCheckPaymentByIdRequest
{
"type": "object",
"title": "ApproveCheckPaymentRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "additionalVerification"
}
}
}
}
}
ArchiveCustomerByIdRequest
{
"type": "object",
"title": "ArchiveCustomerRequest",
"properties": {
"type": {
"enum": [
"archiveCustomer"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"Inactive",
"FraudACHActivity",
"FraudCardActivity",
"FraudCheckActivity",
"FraudApplicationHistory",
"FraudAccountActivity",
"FraudClientIdentified",
"FraudLinkedToFraudulentCustomer"
],
"type": "string"
}
}
}
}
}
CancelApplicationByIdRequest
{
"type": "object",
"title": "CancelApplicationRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"cancelApplication"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"type": "string"
}
}
}
}
}
}
}
CancelApplicationByIdResponse
{
"type": "object",
"title": "UnitCancelApplicationResponse",
"properties": {
"data": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
"included": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items"
}
}
}
}
CloseACardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
CloseAnAccountByIdRequest
{
"type": "object",
"title": "CloseAccountRequest",
"properties": {
"data": {
"type": "object",
"title": "CloseAccountRequest",
"properties": {
"type": {
"enum": [
"creditAccountClose",
"depositAccountClose"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"ByCustomer",
"Fraud"
],
"type": "string",
"default": "ByCustomer"
},
"fraudReason": {
"enum": [
"ACHActivity",
"CardActivity",
"CheckActivity",
"ApplicationHistory",
"AccountActivity",
"ClientIdentified",
"IdentityTheft",
"LinkedToFraudulentCustomer"
],
"type": "string",
"nullable": true
}
}
}
}
}
}
}
ConfirmCheckDepositByIdResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
CreateACardViaApiRequest
{
"type": "object",
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateIndividualDebitCard"
},
{
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessDebitCard"
},
{
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessCreditCard"
},
{
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateIndividualVirtualDebitCard"
},
{
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessVirtualDebitCard"
},
{
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessVirtualCreditCard"
}
]
}
},
"definitions": {
"BIN": {
"type": "object",
"required": [
"bin",
"institutionId"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"institutionId": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"CreateBusinessDebitCard": {
"type": "object",
"title": "Create Business Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessDebitCard"
],
"type": "string",
"default": "businessDebitCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"expiryDate": {
"type": "string",
"pattern": "^(1[0-2]|0[1-9])/(\\d{2})$|^(\\d{4})-(1[0-2]|0[1-9])$|^(\\d{2})-(1[0-2]|0[1-9])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"shippingAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"activeForOnlineUse": {
"type": "boolean"
},
"printOnlyBusinessName": {
"type": "boolean"
},
"additionalEmbossedText": {
"type": "string",
"maxLength": 26
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"createCardRelationships": {
"type": "object",
"title": "createCardRelationships",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"customer": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"defaultFundingAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
},
"CreateBusinessCreditCard": {
"type": "object",
"title": "Create Business Credit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessCreditCard"
],
"type": "string",
"default": "businessCreditCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"expiryDate": {
"type": "string",
"pattern": "^(1[0-2]|0[1-9])/(\\d{2})$|^(\\d{4})-(1[0-2]|0[1-9])$|^(\\d{2})-(1[0-2]|0[1-9])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"shippingAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"activeForOnlineUse": {
"type": "boolean"
},
"printOnlyBusinessName": {
"type": "boolean"
},
"additionalEmbossedText": {
"type": "string",
"maxLength": 26
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateIndividualDebitCard": {
"type": "object",
"title": "Create Individual Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"individualDebitCard"
],
"type": "string",
"default": "individualDebitCard"
},
"attributes": {
"type": "object",
"properties": {
"bin": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/BIN"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"expiryDate": {
"type": "string",
"pattern": "^(1[0-2]|0[1-9])/(\\d{2})$|^(\\d{4})-(1[0-2]|0[1-9])$|^(\\d{2})-(1[0-2]|0[1-9])$"
},
"cardDesignId": {
"type": "string",
"maxLength": 16
},
"cardQualifier": {
"type": "string",
"pattern": "^(\\d{3})|([ ]{3})$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"shippingAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"activeForOnlineUse": {
"type": "boolean"
},
"printOnlyBusinessName": {
"type": "boolean"
},
"additionalEmbossedText": {
"type": "string",
"maxLength": 26
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateBusinessVirtualDebitCard": {
"type": "object",
"title": "Create Business Virtual Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessVirtualDebitCard"
],
"type": "string",
"default": "businessVirtualDebitCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"expiryDate": {
"type": "string",
"pattern": "^(1[0-2]|0[1-9])/(\\d{2})$|^(\\d{4})-(1[0-2]|0[1-9])$|^(\\d{2})-(1[0-2]|0[1-9])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateBusinessVirtualCreditCard": {
"type": "object",
"title": "Create Business Virtual Credit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessVirtualCreditCard"
],
"type": "string",
"default": "businessVirtualCreditCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"expiryDate": {
"type": "string",
"pattern": "^(1[0-2]|0[1-9])/(\\d{2})$|^(\\d{4})-(1[0-2]|0[1-9])$|^(\\d{2})-(1[0-2]|0[1-9])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateIndividualVirtualDebitCard": {
"type": "object",
"title": "Create Individual Virtual Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"individualVirtualDebitCard"
],
"type": "string",
"default": "individualVirtualDebitCard"
},
"attributes": {
"type": "object",
"properties": {
"bin": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/BIN"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"expiryDate": {
"type": "string",
"pattern": "^(1[0-2]|0[1-9])/(\\d{2})$|^(\\d{4})-(1[0-2]|0[1-9])$|^(\\d{2})-(1[0-2]|0[1-9])$"
},
"cardQualifier": {
"type": "string",
"pattern": "^\\d{3}$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
}
}
}
CreateACardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
CreateADocumentForAnApplicationViaApiResponse
{
"type": "object",
"title": "UnitDocumentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items"
}
}
}
CreateAPaymentViaApiRequest
{
"type": "object",
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchPayment"
},
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchPaymentCounterparty"
},
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchPaymentPlaid"
},
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBookPayment"
},
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateWirePayment"
},
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBillPayment"
},
{
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreatePushToCardPayment"
}
]
}
},
"definitions": {
"CreateAchPayment": {
"type": "object",
"title": "Create ACH Payment to inline Counterparty",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"direction",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"enum": [
"WEB",
"CCD",
"PPD"
],
"type": "string"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"type": "string"
},
"counterparty": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"CreateBillPayment": {
"type": "object",
"title": "Create Bill Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "billPayment"
},
"attributes": {
"type": "object",
"required": [
"billerId",
"accountNumber",
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"billerId": {
"type": "string"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"CreateBookPayment": {
"type": "object",
"title": "Create Book Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "bookPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"description": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"transactionSummaryOverride": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterpartyAccount"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
},
"counterpartyAccount": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyAccountRelationship"
}
}
}
}
},
"CreateWirePayment": {
"type": "object",
"title": "Create Wire Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "wirePayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"direction": {
"enum": [
"Credit"
],
"type": "string"
},
"description": {
"type": "string"
},
"counterparty": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/wireCounterparty"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"accountRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"creditAccount",
"batchAccount"
],
"type": "string"
}
}
}
}
},
"additionalProperties": false,
"CreateAchPaymentPlaid": {
"type": "object",
"title": "Create ACH Payment with Plaid token",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"direction",
"plaidProcessorToken"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"enum": [
"WEB",
"CCD",
"PPD"
],
"type": "string"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"counterpartyName": {
"type": "string"
},
"plaidProcessorToken": {
"type": "string",
"pattern": "^processor-.*$"
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"CreatePushToCardPayment": {
"type": "object",
"title": "Create Push To Card Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "pushToCardPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"configuration"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"description": {
"type": "string"
},
"configuration": {
"type": "object",
"properties": {
"astra": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/astra"
}
}
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"counterpartyRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"counterparty"
],
"type": "string"
}
}
}
}
},
"CreateAchPaymentCounterparty": {
"type": "object",
"title": "Create ACH Payment to linked Counterparty",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"direction"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"enum": [
"WEB",
"CCD",
"PPD"
],
"type": "string"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterparty"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
},
"counterparty": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyRelationship"
}
}
}
}
},
"counterpartyAccountRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount"
],
"type": "string"
}
}
}
}
}
}
}
CreateARepaymentViaApiRequest
{
"type": "object",
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1repayments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchRepayment"
},
{
"$ref": "#/paths/~1repayments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBookRepayment"
}
]
}
},
"definitions": {
"CreateAchRepayment": {
"type": "object",
"title": "Create ACH Repayment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achRepayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sameDay": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"creditAccount",
"counterparty"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"counterparty": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"creditAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
},
"CreateBookRepayment": {
"type": "object",
"title": "Create Book Repayment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "bookRepayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"transactionSummaryOverride": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"creditAccount",
"counterpartyAccount"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"creditAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"counterpartyAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
}
}
CreateARepaymentViaApiResponse
{
"type": "object",
"title": "UnitRepaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1repayments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
CreateAccountViaApiRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateCreditAccount"
},
{
"$ref": "#/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount"
}
]
}
},
"definitions": {
"CreateCreditAccount": {
"type": "object",
"title": "Create Credit Account",
"properties": {
"type": {
"enum": [
"creditAccount"
],
"type": "string",
"default": "creditAccount"
},
"attributes": {
"type": "object",
"required": [
"creditTerms",
"creditLimit"
],
"properties": {
"tags": {
"type": "object",
"nullable": true
},
"creditLimit": {
"type": "integer"
},
"creditTerms": {
"type": "string"
},
"idempotencyKey": {
"type": "string",
"nullable": true
}
}
},
"relationships": {
"type": "object",
"properties": {
"customer": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerLinkage"
}
}
}
}
},
"CreateDepositAccount": {
"type": "object",
"title": "Create Deposit Account",
"properties": {
"type": {
"enum": [
"depositAccount"
],
"type": "string",
"default": "depositAccount"
},
"attributes": {
"type": "object",
"required": [
"depositProduct"
],
"properties": {
"tags": {
"type": "object",
"nullable": true
},
"depositProduct": {
"type": "string"
},
"idempotencyKey": {
"type": "string",
"nullable": true
}
}
},
"relationships": {
"type": "object",
"properties": {
"customer": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerLinkage"
},
"customers": {
"type": "object",
"title": "Customers Relationship",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "customer"
}
}
}
}
}
}
}
}
}
}
}
}
CreateApplicationFormViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"default": "applicationForm"
},
"attributes": {
"type": "object",
"properties": {
"lang": {
"enum": [
"en",
"es"
],
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"applicantDetails": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormPrefill"
},
"settingsOverride": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormSettingsOverride"
},
"requireIdVerification": {
"$ref": "#/paths/~1application-forms/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/requireIdVerification"
},
"allowedApplicationTypes": {
"type": "array",
"items": {
"enum": [
"Individual",
"Business",
"SoleProprietorship"
],
"type": "string"
}
},
"hideApplicationProgressTracker": {
"type": "boolean"
}
}
},
"relationships": {
"type": "object",
"title": "createApplicationFormRelationships",
"required": [],
"properties": {
"application": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
},
"definitions": {
"requireIdVerification": {
"type": "object",
"properties": {
"officer": {
"type": "boolean",
"default": false
},
"individual": {
"type": "boolean",
"default": false
},
"beneficialOwners": {
"type": "boolean",
"default": false
}
}
}
}
}
CreateApplicationFormViaApiResponse
{
"type": "object",
"title": "UnitApplicationFormResponse",
"properties": {
"data": {
"type": "object",
"title": "Application Form",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "applicationForm"
},
"attributes": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"stage": {
"enum": [
"ChooseBusinessOrIndividual",
"EnterIndividualInformation",
"IndividualPhoneVerification",
"IndividualApplicationCreated",
"EnterBusinessInformation",
"EnterBusinessAdditionalInformation",
"EnterOfficerInformation",
"BusinessPhoneVerification",
"EnterBeneficialOwnersInformation",
"BusinessApplicationCreated",
"EnterSoleProprietorshipInformation",
"EnterSoleProprietorshipBusinessInformation",
"SoleProprietorshipPhoneVerification",
"SoleProprietorshipApplicationCreated"
],
"type": "string"
},
"applicantDetails": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormPrefill"
},
"settingsOverride": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormSettingsOverride"
},
"allowedApplicationTypes": {
"type": "array",
"items": {
"enum": [
"Individual",
"Business",
"SoleProprietorship"
],
"type": "string"
}
}
}
},
"relationships": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationFormRelationships"
}
},
"definitions": {
"ApplicationFormPrefill": {
"type": "object",
"title": "Application Form Prefilled",
"properties": {
"dba": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"contact": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact"
},
"officer": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer"
},
"website": {
"type": "string"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string"
},
"entityType": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"applicationType": {
"enum": [
"Individual",
"Business",
"SoleProprietorship"
],
"type": "string"
},
"beneficialOwners": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createBeneficialOwner"
}
},
"stateOfIncorporation": {
"type": "string",
"maxLength": 2,
"minLength": 2
}
}
},
"applicationFormRelationships": {
"type": "object",
"title": "applicationFormRelationships",
"required": [],
"properties": {
"application": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"application"
],
"type": "string"
}
}
}
}
}
}
},
"ApplicationFormSettingsOverride": {
"type": "object",
"properties": {
"redirectUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"clientTermsUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"depositTermsUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"privacyPolicyUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"cardholderTermsUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"cashAdvancedTermsUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"additionalDisclosures": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"title": {
"type": "string"
}
}
}
},
"debitCardDisclosureUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"electronicDisclosuresUrl": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
}
}
}
}
}
}
}
CreateApplicationViaApiRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateIndividualApplication"
},
{
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateSoleProprietorApplication"
},
{
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication"
},
{
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication"
}
]
}
},
"definitions": {
"createOfficer": {
"type": "object",
"title": "CreateOfficer",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth",
"occupation"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"title": {
"enum": [
"President",
"CEO",
"COO",
"CFO",
"BenefitsAdministrationOfficer",
"CIO",
"VP",
"AVP",
"Treasurer",
"Secretary",
"Controller",
"Manager",
"Partner",
"Member"
],
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string"
}
}
},
"evaluationParams": {
"type": "object",
"title": "EvaluationParams",
"properties": {
"requireIdVerification": {
"type": "boolean",
"default": false
},
"useSelfieVerification": {
"enum": [
"Never",
"ReplaceIdentification",
"Always"
],
"type": "string"
}
}
},
"createBeneficialOwner": {
"type": "object",
"title": "CreateBeneficialOwner",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"percentage": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string"
}
}
},
"CreateTrustApplication": {
"type": "object",
"title": "Create Trust Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "trustApplication"
},
"attributes": {
"type": "object",
"required": [
"name",
"stateOfIncorporation",
"revocability",
"sourceOfFunds",
"taxId",
"grantor",
"trustees",
"beneficiaries",
"contact"
],
"properties": {
"ip": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"taxId": {
"type": "string"
},
"contact": {
"type": "object",
"title": "TrustContact",
"properties": {
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
}
}
},
"grantor": {
"type": "object",
"title": "Grantor",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"evaluationId": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
}
}
},
"trustees": {
"type": "array",
"items": {
"type": "object",
"title": "Trustee",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"matriculaConsular": {
"type": "string"
}
}
}
},
"revocability": {
"enum": [
"Revocable",
"Irrevocable"
],
"type": "string"
},
"beneficiaries": {
"type": "array",
"items": {
"type": "object",
"title": "Beneficiary",
"required": [
"fullName",
"dateOfBirth"
],
"properties": {
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"dateOfBirth": {
"type": "string",
"format": "date"
}
}
}
},
"sourceOfFunds": {
"enum": [
"Inheritance",
"Salary",
"Savings",
"InvestmentReturns",
"Gifts"
],
"type": "string"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"deviceFingerprints": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider",
"value"
],
"properties": {
"value": {
"type": "string"
},
"provider": {
"enum": [
"iovation"
],
"type": "string"
}
}
},
"maxItems": 1
},
"stateOfIncorporation": {
"type": "string",
"maxLength": 2,
"minLength": 2
}
}
}
}
},
"CreateBusinessApplication": {
"type": "object",
"title": "Create Business Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "businessApplication"
},
"attributes": {
"type": "object",
"required": [
"name",
"ein",
"entityType",
"stateOfIncorporation",
"phone",
"address",
"contact",
"officer",
"beneficialOwners"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"contact": {
"type": "object",
"title": "Contact",
"properties": {
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
}
}
},
"officer": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer"
},
"purpose": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"website": {
"type": "string"
},
"cashFlow": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/cashFlow"
},
"industry": {
"enum": [
"Retail",
"Wholesale",
"Restaurants",
"Hospitals",
"Construction",
"Insurance",
"Unions",
"RealEstate",
"FreelanceProfessional",
"OtherProfessionalServices",
"OnlineRetailer",
"OtherEducationServices"
],
"type": "string"
},
"entityType": {
"enum": [
"Corporation",
"LLC",
"Partnership",
"PubliclyTradedCorporation",
"PrivatelyHeldCorporation",
"NotForProfitOrganization"
],
"type": "string"
},
"stockSymbol": {
"type": "string",
"maxLength": 5,
"minLength": 1
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/annualRevenue"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"beneficialOwners": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createBeneficialOwner"
}
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/numberOfEmployees"
},
"deviceFingerprints": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items"
},
"maxItems": 1
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"yearOfIncorporation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/yearOfIncorporation"
},
"countriesOfOperation": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"minItems": 1
},
"stateOfIncorporation": {
"type": "string",
"maxLength": 2,
"minLength": 2
}
}
}
}
},
"createPowerOfAttorneyAgent": {
"type": "object",
"title": "CreatePowerOfAttorneyAgent",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"jwtSubject": {
"type": "string",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string"
}
}
},
"CreateIndividualApplication": {
"type": "object",
"title": "Create Individual Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "individualApplication"
},
"attributes": {
"type": "object",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ip": {
"type": "string"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}|\\d{4}",
"nullable": true
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string",
"nullable": true
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/components/schemas/nationalityNullable"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"deviceFingerprints": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items"
},
"maxItems": 1
},
"powerOfAttorneyAgent": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent"
}
}
}
}
},
"CreateSoleProprietorApplication": {
"type": "object",
"title": "Create Sole Proprietor Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "individualApplication"
},
"attributes": {
"type": "object",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string",
"nullable": true
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$",
"nullable": true
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}|\\d{4}",
"nullable": true
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"website": {
"type": "string"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string",
"nullable": true
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/components/schemas/nationalityNullable"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/annualRevenue"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string",
"nullable": true
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/numberOfEmployees"
},
"deviceFingerprints": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items"
},
"maxItems": 1
},
"soleProprietorship": {
"type": "boolean",
"default": false
},
"powerOfAttorneyAgent": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent"
}
}
}
}
}
}
}
CreateApplicationViaApiResponse
{
"type": "object",
"title": "UnitCreateApplicationResponse",
"properties": {
"data": {
"type": "object",
"title": "Application",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"officer": {
"type": "object",
"title": "Officer",
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"title": {
"enum": [
"President",
"CEO",
"COO",
"CFO",
"BenefitsAdministrationOfficer",
"CIO",
"VP",
"AVP",
"Treasurer",
"Secretary",
"Controller",
"Manager",
"Partner",
"Member"
],
"type": "string"
},
"status": {
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"maskedPassport": {
"type": "string"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"beneficialOwner": {
"type": "object",
"title": "Beneficial Owner",
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"percentage": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"maskedPassport": {
"type": "string"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"TrustApplication": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"name",
"stateOfIncorporation",
"contact"
],
"properties": {
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"taxId": {
"type": "string"
},
"status": {
"enum": [
"AwaitingDocuments",
"PendingReview",
"Approved",
"Denied",
"Pending",
"Canceled"
],
"type": "string"
},
"contact": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/contact"
},
"grantor": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/grantor"
},
"message": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"trustees": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/trustees/items"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"evaluationId": {
"type": "string"
},
"revocability": {
"enum": [
"Revocable",
"Irrevocable"
],
"type": "string"
},
"sourceOfFunds": {
"enum": [
"Inheritance",
"Salary",
"Savings",
"InvestmentReturns",
"Gifts"
],
"type": "string"
},
"decisionMethod": {
"enum": [
"Manually",
"Automatically"
],
"type": "string"
},
"decisionReason": {
"type": "string"
},
"decisionUserId": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"decisionDateTime": {
"type": "string",
"format": "date-time"
},
"evaluationOutcome": {
"type": "string"
},
"ipLocationDetails": {
"type": "object"
},
"evaluationEntityId": {
"type": "string"
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"phoneLocationDetails": {
"type": "object"
},
"stateOfIncorporation": {
"type": "string",
"pattern": "^((A[LKSZR])|(C[AOT])|(D[EC])|(F[ML])|(G[AU])|(HI)|(I[DLNA])|(K[SY])|(LA)|(M[EHDAINSOT])|(N[EVHJMYCD])|(MP)|(O[HKR])|(P[WAR])|(RI)|(S[CD])|(T[NX])|(UT)|(V[TIA])|(W[AVIY]))$"
}
}
},
"relationships": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships"
}
}
}
],
"title": "TrustApplication"
},
"BusinessApplication": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"name",
"entityType",
"stateOfIncorporation",
"contact",
"officer",
"beneficialOwners"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string",
"nullable": true
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/status"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"contact": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact"
},
"message": {
"type": "string"
},
"officer": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/officer"
},
"purpose": {
"type": "string"
},
"website": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"cashFlow": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/cashFlow"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"entityType": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType"
},
"stockSymbol": {
"type": "string"
},
"evaluationId": {
"type": "string"
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/annualRevenue"
},
"decisionMethod": {
"enum": [
"Manually",
"Automatically"
],
"type": "string"
},
"decisionReason": {
"type": "string"
},
"decisionUserId": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"beneficialOwners": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/beneficialOwner"
}
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"decisionDateTime": {
"type": "string",
"format": "date-time"
},
"evaluationOutcome": {
"type": "string"
},
"ipLocationDetails": {
"type": "object"
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/numberOfEmployees"
},
"evaluationEntityId": {
"type": "string"
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"yearOfIncorporation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/yearOfIncorporation"
},
"countriesOfOperation": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"minItems": 1
},
"phoneLocationDetails": {
"type": "object"
},
"stateOfIncorporation": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/stateOfIncorporation"
}
}
},
"relationships": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships"
}
}
}
],
"title": "BusinessApplication"
},
"powerOfAttorneyAgent": {
"type": "object",
"title": "PowerOfAttorneyAgent",
"required": [
"status",
"fullName"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"maskedPassport": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"IndividualApplication": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"fullName"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string"
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"email": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/status"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"message": {
"type": "string"
},
"website": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/annualRevenue"
},
"decisionMethod": {
"enum": [
"Manually",
"Automatically"
],
"type": "string"
},
"decisionReason": {
"type": "string"
},
"decisionUserId": {
"type": "string"
},
"maskedPassport": {
"type": "string"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"decisionDateTime": {
"type": "string",
"format": "date-time"
},
"evaluationScores": {
"type": "object"
},
"evaluationOutcome": {
"type": "string"
},
"ipLocationDetails": {
"type": "object"
},
"matriculaConsular": {
"type": "string"
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/numberOfEmployees"
},
"evaluationEntityId": {
"type": "string"
},
"soleProprietorship": {
"type": "boolean"
},
"phoneLocationDetails": {
"type": "object"
},
"powerOfAttorneyAgent": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/powerOfAttorneyAgent"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships"
}
}
}
],
"title": "IndividualApplication"
},
"applicationRelationships": {
"type": "object",
"title": "applicationRelationships",
"properties": {
"org": {
"$ref": "#/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org"
},
"customer": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"trustees": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "trustee"
}
}
}
}
}
},
"documents": {
"type": "object",
"title": "documentsRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "document"
}
}
}
}
},
"additionalProperties": true
},
"beneficiaries": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "beneficiary"
}
}
}
}
}
},
"applicationForm": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"beneficialOwners": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "beneficialOwner"
}
}
}
}
}
}
}
}
},
"discriminator": {
"mapping": {
"trustApplication": "#/definitions/TrustApplication",
"businessApplication": "#/definitions/BusinessApplication",
"individualApplication": "#/definitions/IndividualApplication"
},
"propertyName": "type"
}
},
"included": {
"type": "array",
"items": {
"type": "object",
"title": "Application Document Document",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "document"
},
"attributes": {
"type": "object",
"required": [
"status"
],
"properties": {
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"passport": {
"type": "string"
},
"reasonCode": {
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"documentType": {
"type": "string"
},
"evaluationId": {
"type": "string"
},
"backDocumentId": {
"type": "string"
},
"frontDocumentId": {
"type": "string"
},
"matriculaConsular": {
"type": "string"
},
"backDocumentStoreId": {
"type": "string"
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"frontDocumentStoreId": {
"type": "string"
},
"stateOfIncorporation": {
"type": "string"
}
}
}
}
}
}
}
}
CreateCheckDepositViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"checkDeposit"
],
"type": "string",
"default": "checkDeposit"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships"
}
}
}
},
"definitions": {
"createCheckDepositRelationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
}
}
}
}
}
}
}
}
CreateCheckDepositViaApiResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"type": "object",
"title": "Check Deposit",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"checkDeposit"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"description",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string",
"nullable": true
},
"status": {
"enum": [
"AwaitingImages",
"AwaitingFrontImage",
"AwaitingBackImage",
"Pending",
"PendingReview",
"AwaitingCustomerConfirmation",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"vendor": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"reasonText": {
"type": "string"
},
"checkNumber": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"statusSetBy": {
"type": "string"
},
"counterparty": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/counterparty"
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/statusEvent"
}
},
"settlementDate": {
"type": "string",
"format": "date"
},
"statusCreatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"relationships": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/checkDepositRelationships"
}
},
"definitions": {
"statusEvent": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "object",
"properties": {
"type": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/checkDepositStatus"
}
}
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
}
}
},
"counterparty": {
"type": "object",
"title": "Counterparty",
"required": [
"routingNumber",
"accountNumber",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 250,
"minLength": 1
},
"accountNumber": {
"type": "string",
"maxLength": 17
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"checkDepositStatus": {
"enum": [
"AwaitingImages",
"AwaitingFrontImage",
"AwaitingBackImage",
"AwaitingCustomerConfirmation",
"Pending",
"PendingReview",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"checkDepositRelationships": {
"type": "object",
"title": "checkDepositRelationships",
"required": [
"account"
],
"properties": {
"org": {
"$ref": "#/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org"
},
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"batchAccount"
],
"type": "string"
}
}
}
},
"additionalProperties": true
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"transaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "transaction"
}
}
}
}
}
}
}
}
}
}
}
CreateCheckPaymentViaApiRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/paths/~1check-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/checkPayment"
}
},
"definitions": {
"checkPayment": {
"type": "object",
"title": "Check Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "checkPayment"
},
"attributes": {
"type": "object",
"required": [
"counterparty",
"amount",
"idempotencyKey",
"description"
],
"properties": {
"memo": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"sendDate": {
"type": "string",
"format": "date"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"counterparty": {
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"maxLength": 40
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"counterpartyMoved": {
"type": "boolean"
}
}
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1check-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships"
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"customer"
],
"properties": {
"account": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer"
],
"type": "string"
}
}
}
}
}
}
}
}
}
CreateCheckPaymentViaApiResponse
{
"type": "object",
"title": "UnitCheckPaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1check-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
CreateCounterpartyViaApiRequest
{
"type": "object",
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchCounterparty"
},
{
"$ref": "#/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreatePlaidCounterparty"
}
]
}
},
"definitions": {
"CreateAchCounterparty": {
"type": "object",
"title": "Create Ach Counterparty",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"type",
"name",
"accountType",
"accountNumber",
"routingNumber"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"type": {
"enum": [
"Business",
"Person",
"Unknown"
],
"type": "string"
},
"accountType": {
"enum": [
"Checking",
"Savings",
"Loan"
],
"type": "string"
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"accountNumber": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCounterpartyRelationships"
}
}
},
"CreatePlaidCounterparty": {
"type": "object",
"title": "Create Plaid Counterparty",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"type",
"plaidProcessorToken"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"type": {
"enum": [
"Business",
"Person",
"Unknown"
],
"type": "string"
},
"verifyName": {
"type": "boolean",
"default": false
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"plaidProcessorToken": {
"$ref": "#/paths/~1counterparties~1%7BcounterpartyId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCounterparty/properties/attributes/properties/plaidProcessorToken"
}
}
},
"relationships": {
"$ref": "#/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCounterpartyRelationships"
}
}
},
"createCounterpartyRelationships": {
"type": "object",
"required": [
"customer"
],
"properties": {
"customer": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
CreateCounterpartyViaApiResponse
{
"type": "object",
"title": "UnitCounterpartyResponse",
"properties": {
"data": {
"type": "object",
"title": "Counterparty Document",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"routingNumber",
"accountNumber",
"accountType",
"type",
"name",
"createdAt",
"permissions"
],
"properties": {
"bank": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"type": {
"enum": [
"Business",
"Person",
"Unknown"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"accountType": {
"enum": [
"Checking",
"Savings",
"Loan"
],
"type": "string"
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"accountNumber": {
"type": "string",
"pattern": "^\\d{1,17}$"
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"relationships": {
"$ref": "#/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/counterpartyRelationships"
}
},
"definitions": {
"counterpartyRelationships": {
"type": "object",
"title": "counterpartyRelationships",
"required": [
"customer"
],
"properties": {
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "customer"
}
}
}
}
}
}
}
}
}
}
}
CreateCustomerTokenVerificationViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "customerTokenVerification"
},
"attributes": {
"type": "object",
"required": [
"channel"
],
"properties": {
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"appHash": {
"type": "string",
"maxLength": 11,
"minLength": 11
},
"channel": {
"enum": [
"sms",
"call"
],
"type": "string"
},
"language": {
"enum": [
"en",
"af",
"ar",
"ca",
"zh",
"zh-CN",
"zh-HK",
"hr",
"cs",
"da",
"nl",
"en-GB",
"et",
"fi",
"fr",
"de",
"el",
"he",
"hi",
"hu",
"id",
"it",
"ja",
"kn",
"ko",
"ms",
"mr",
"nb",
"pl",
"pt-BR",
"pt",
"ro",
"ru",
"sk",
"es",
"sv",
"tl",
"te",
"th",
"tr",
"vi"
],
"type": "string"
}
}
}
}
}
}
}
CreateCustomerTokenVerificationViaApiResponse
{
"type": "object",
"title": "UnitCustomerTokenVerificationResponse",
"properties": {
"data": {
"type": "object",
"title": "CustomerTokenVerification",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "customerTokenVerification"
},
"attributes": {
"type": "object",
"properties": {
"verificationToken": {
"type": "string"
}
}
}
}
}
}
}
CreateCustomerTokenViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "customerToken"
},
"attributes": {
"type": "object",
"properties": {
"scope": {
"type": "string"
},
"jwtToken": {
"type": "string"
},
"expiresIn": {
"type": "integer"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
}
},
"type": {
"enum": [
"card",
"account"
],
"type": "string"
}
}
},
"minItems": 1
},
"upgradableScope": {
"type": "string"
},
"verificationCode": {
"type": "string"
},
"verificationToken": {
"type": "string"
}
}
}
}
}
}
}
CreateCustomerTokenViaApiResponse
{
"type": "object",
"title": "UnitCustomerTokenResponse",
"properties": {
"data": {
"type": "object",
"title": "CustomerToken",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "customerToken"
},
"attributes": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"expiresIn": {
"type": "integer"
}
}
}
}
}
}
}
CreateFeeViaApiRequest
{
"data": {
"type": "object",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"fee"
],
"type": "string",
"default": "fee"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"type": "object",
"maxProperties": 15
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createFeeRelationships"
}
}
},
"type": "object",
"definitions": {
"createFeeRelationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
CreateFeeViaApiResponse
{
"type": "object",
"title": "UnitFeeResponse",
"properties": {
"data": {
"type": "object",
"title": "Fee",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "fee"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50
}
}
},
"relationships": {
"$ref": "#/paths/~1fees/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/feeRelationships"
}
},
"definitions": {
"feeRelationships": {
"type": "object",
"title": "feeRelationships",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
}
}
CreateOrgApiTokenViaApiRequest
{
"type": "object",
"title": "Create API Token",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "apiToken"
},
"attributes": {
"type": "object",
"required": [
"description",
"expiration"
],
"properties": {
"scope": {
"type": "string"
},
"sourceIp": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
}
},
"type": {
"enum": [
"card",
"account"
],
"type": "string"
}
}
},
"minItems": 1
},
"expiration": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
}
}
}
}
}
}
}
CreateOrgApiTokenViaApiResponse
{
"type": "object",
"title": "UnitApiTokenResponse",
"properties": {
"data": {
"type": "object",
"title": "apiToken",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "apiToken"
},
"attributes": {
"type": "object",
"required": [
"createdAt"
],
"properties": {
"token": {
"type": "string"
},
"sourceIp": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"expiration": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
}
}
}
}
}
}
}
CreateRecurringPaymentViaApiRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRecurringCreditAchPayment"
},
{
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRecurringDebitAchPayment"
},
{
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRecurringCreditBookPayment"
}
]
}
},
"definitions": {
"schedule": {
"oneOf": [
{
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/monthlySchedule"
}
],
"title": "schedule"
},
"monthlySchedule": {
"type": "object",
"title": "Create Monthly Schedule",
"required": [
"interval"
],
"properties": {
"endTime": {
"type": "string",
"format": "date"
},
"interval": {
"enum": [
"Monthly",
"Weekly"
],
"type": "string"
},
"dayOfWeek": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string"
},
"startTime": {
"type": "string",
"format": "date"
},
"dayOfMonth": {
"type": "integer",
"maximum": 28,
"minimum": -5
},
"totalNumberOfPayments": {
"type": "integer",
"minimum": 1
}
}
},
"createRecurringDebitAchPayment": {
"type": "object",
"title": "Create Recurring Debit ACH Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "recurringDebitAchPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"schedule"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sameDay": {
"type": "boolean",
"default": false
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"clearingDaysOverride": {
"type": "integer",
"minimum": 0
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterparty"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
},
"counterparty": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyRelationship"
}
}
}
}
},
"createRecurringCreditAchPayment": {
"type": "object",
"title": "Create Recurring Credit ACH Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "recurringCreditAchPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"schedule"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterparty"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
},
"counterparty": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyRelationship"
}
}
}
}
},
"createRecurringCreditBookPayment": {
"type": "object",
"title": "Create Recurring Credit Book Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "recurringCreditBookPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"schedule"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule"
},
"description": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"transactionSummaryOverride": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterpartyAccount"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
},
"counterpartyAccount": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyAccountRelationship"
}
}
}
}
}
}
}
CreateRecurringPaymentViaApiResponse
{
"type": "object",
"title": "UnitRecurringPaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
CreateRewardViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "reward"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1rewards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRewardRelationships"
}
}
}
},
"definitions": {
"createRewardRelationships": {
"type": "object",
"required": [
"receivingAccount"
],
"properties": {
"fundingAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"receivingAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"rewardedTransaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "transaction"
}
}
}
}
}
}
}
}
}
CreateRewardViaApiResponse
{
"type": "object",
"title": "UnitRewardResponse",
"properties": {
"data": {
"type": "object",
"title": "Reward",
"required": [
"type",
"id",
"relationships",
"attributes"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "reward"
},
"attributes": {
"type": "object",
"required": [
"description",
"createdAt",
"amount",
"tags",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Rejected",
"Sent"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"maxLength": 50
},
"rejectReason": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/rewardRelationships"
}
},
"definitions": {
"rewardRelationships": {
"type": "object",
"required": [
"receivingAccount",
"fundingAccount",
"customer"
],
"properties": {
"card": {
"type": "object",
"title": "cardRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "card"
}
}
}
}
},
"customer": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"transaction": {
"type": "object",
"title": "transactionRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "transaction"
}
}
}
}
},
"fundingAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"receivingAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"rewardedTransaction": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
}
}
CreateWebhookViaApiRequest
{
"type": "object",
"title": "createWebhook",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "webhook"
},
"attributes": {
"type": "object",
"required": [
"label",
"url",
"token",
"contentType",
"deliveryMode"
],
"properties": {
"url": {
"type": "string"
},
"label": {
"type": "string"
},
"token": {
"type": "string"
},
"contentType": {
"enum": [
"Json",
"JsonAPI"
],
"type": "string"
},
"deliveryMode": {
"type": "string"
},
"includeResources": {
"type": "boolean"
},
"subscriptionType": {
"enum": [
"All",
"OnlyAuthorizationRequest"
],
"type": "string"
}
}
}
}
}
}
}
CreateWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"type": "object",
"title": "Webhook",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string",
"default": "webhook"
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"label": {
"type": "string"
},
"token": {
"type": "string"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"contentType": {
"enum": [
"Json",
"JsonAPI"
],
"type": "string"
},
"deliveryMode": {
"enum": [
"AtMostOnce",
"AtLeastOnce"
],
"type": "string"
},
"subscriptionType": {
"type": "string"
}
}
}
}
}
}
}
DeclineAuthorizationRequestViaApiRequest
{
"type": "object",
"title": "DeclineAuthorizationRequest",
"properties": {
"data": {
"$ref": "#/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/declineAuthorizationRequest"
}
}
}
DeclineAuthorizationRequestViaApiResponse
{
"type": "object",
"title": "UnitAuthorizationRequestResponse",
"properties": {
"data": {
"$ref": "#/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
DisableWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
DownloadADocumentBackSideViaApiResponse
{
"type": "string",
"format": "binary"
}
DownloadADocumentViaApiResponse
{
"type": "string",
"format": "binary"
}
EnableWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
FireEventByIdResponse
{
"type": "object",
"title": "UnitEventResponse",
"properties": {
"data": {
"$ref": "#/paths/~1events~1%7BeventId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
FreezeACardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
FreezeAnAccountByIdRequest
{
"type": "object",
"title": "FreezeAccountRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"creditAccountFreeze",
"accountFreeze"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"Fraud",
"Other"
],
"type": "string"
},
"reasonText": {
"type": "string",
"nullable": true
}
}
}
}
}
}
}
GetABackImageByApiResponse
{
"type": "string",
"format": "binary"
}