Community Federal Savings Bank
API docs by Redocly

Accounts API Docs (v1.14.10.20260128)

Download OpenAPI specification:

AccountEntityRelationships

/api/AccountEntityRelationships

Request Body schema:
Array
virtualAccountID
string or null <uuid>
entityID
string or null <uuid>
relationshipCode
required
string (AccountEntityRelationshipCodes)
Enum: "AR" "CP" "BO" "DI" "SO" "Borrower" "CoBorrower"

AR - Authorized Representative CP - Control Person BO - BeneficialOwner DI - Director SO - SigningOfficer Borrower - Borrower CoBorrower - CoBorrower

ownershipPercent
number or null <double> [ 0 .. 100 ]
authorizedSignerInd
required
boolean
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}

/api/AccountEntityRelationships

Request Body schema:
accountEntityRelationshipID
required
string <uuid>
relationshipCode
string (AccountEntityRelationshipCodes)
Enum: "AR" "CP" "BO" "DI" "SO" "Borrower" "CoBorrower"

AR - Authorized Representative CP - Control Person BO - BeneficialOwner DI - Director SO - SigningOfficer Borrower - Borrower CoBorrower - CoBorrower

ownershipPercent
number or null <double> [ 0 .. 100 ]
authorizedSignerInd
boolean or null
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "accountEntityRelationshipID": "a48a2aab-080a-4331-96fa-dbda66158c45",
  • "relationshipCode": "AR",
  • "ownershipPercent": 49.5,
  • "authorizedSignerInd": true,
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string"
}

/api/AccountEntityRelationships/ByAccount/{accountId}

path Parameters
accountId
required
string <uuid>

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": [
    ]
}

/api/AccountEntityRelationships/{id}

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": {
    }
}

Accounts

/api/Accounts/Validate

Request Body schema:
accountNumber
required
string [ 8 .. 17 ] characters
railID
required
string (RailTypes)
Enum: "ACH" "FEDWIRE" "RTP" "FEDNOW" "SWIFTWIRE"

Responses

Request samples

Content type
{
  • "accountNumber": "stringst",
  • "railID": "ACH"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": {
    }
}

/api/Accounts/ByPartner/{partnerId}

path Parameters
partnerId
required
string <uuid>

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": [
    ]
}

/api/Accounts

Request Body schema:
virtualAccountNumber
required
string

Virtual account number

masterAccountID
required
string <= 14 characters
subAccountInd
required
boolean
productID
required
string <uuid>
accountStatus
required
string (AccountStatuses)
Enum: "Inactive" "Active" "Closed" "OnHold" "Dormant" "ChargedOff" "OriginationsResrticted" "ReceivedRestricted" "AllTransactionsRestricted"
merchantId
string or null <= 10 characters
openedAtUtcDt
required
string <date-time>
closedAtUtcDt
string or null <date-time>
accountPurpose
required
string (AccountPurposes)
Enum: "Investment" "Home" "Retirement" "DailyBanking" "Vehicle" "Leisure" "Education" "Emergency" "Taxes"
accountTitle
required
string <= 100 characters
accountType
required
string (AccountTypes)
Enum: "VA" "CHK" "SAV" "MMK" "TD"
accountClassification
required
string (AccountClassifications)
Enum: "Personal" "Corporate"
accountFlexFields
string or null
required
Array of objects (CreateNestedAccountEntityRelationship)
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "virtualAccountNumber": "1234567890",
  • "masterAccountID": "1234567890",
  • "subAccountInd": true,
  • "productID": "dbb08e34-cbbb-47d7-824b-bc71f5b00e6c",
  • "accountStatus": "Inactive",
  • "merchantId": "ABCD345678",
  • "openedAtUtcDt": "2019-08-24T14:15:22Z",
  • "closedAtUtcDt": "2019-08-24T14:15:22Z",
  • "accountPurpose": "Investment",
  • "accountTitle": "Savings for vacation",
  • "accountType": "VA",
  • "accountClassification": "Personal",
  • "accountFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "accountEntityRelationships": [
    ],
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z",
  • "partnerID": "ae461794-a7aa-4a5a-a2ed-164bbc7dd251"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}

/api/Accounts

Request Body schema:
virtualAccountID
required
string <uuid>
accountStatus
string (AccountStatuses)
Enum: "Inactive" "Active" "Closed" "OnHold" "Dormant" "ChargedOff" "OriginationsResrticted" "ReceivedRestricted" "AllTransactionsRestricted"
accountPurpose
string (AccountPurposes)
Enum: "Investment" "Home" "Retirement" "DailyBanking" "Vehicle" "Leisure" "Education" "Emergency" "Taxes"
accountTitle
string or null <= 100 characters
accountType
string (AccountTypes)
Enum: "VA" "CHK" "SAV" "MMK" "TD"
accountClassification
string (AccountClassifications)
Enum: "Personal" "Corporate"
accountFlexFields
string or null
Array of objects or null (UpdateAccountEntityRelationship)
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "virtualAccountID": "0aaaf252-db6b-46f9-aa82-ac39551855ad",
  • "accountStatus": "Inactive",
  • "accountPurpose": "Investment",
  • "accountTitle": "Savings for vacation",
  • "accountType": "VA",
  • "accountClassification": "Personal",
  • "accountFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "accountEntityRelationships": [
    ],
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string"
}

/api/Accounts/{id}

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
{
  • "eventID": "d66eb199-edae-4511-96e7-d2277ccf1d87",
  • "httpMethodType": "Post",
  • "status": "Continue",
  • "error": "string",
  • "data": {
    }
}