Community Federal Savings Bank
API docs by Redocly

Entities API Docs (v1.14.10.20260128)

Download OpenAPI specification:

Addresses

/api/Addresses/{entityId}/{id}

path Parameters
entityId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

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

/api/Addresses/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/Addresses

Request Body schema:
addressType
required
string (AddressTypes)
Enum: "Mailing" "Alternate" "Physical"
addressPrimaryInd
required
boolean
billingAddressInd
required
boolean
street1
required
string <= 50 characters
street2
string or null <= 50 characters
street3
string or null <= 50 characters
street4
string or null <= 50 characters
city
required
string <= 35 characters
state
required
string <= 2 characters ^[a-zA-Z]*$
zipCodeBaseFive
required
string <= 5 characters
zipCodePlusFour
required
string <= 4 characters ^\d*$
postalCode
required
string <= 10 characters ^\d*$
countryCode
required
string <= 2 characters
countyFipsCode
required
string <= 5 characters
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "addressType": "Mailing",
  • "addressPrimaryInd": true,
  • "billingAddressInd": true,
  • "street1": "string",
  • "street2": "string",
  • "street3": "string",
  • "street4": "string",
  • "city": "NEW YORK",
  • "state": "NY",
  • "zipCodeBaseFive": "54321",
  • "zipCodePlusFour": "9876",
  • "postalCode": "234-7564",
  • "countryCode": "US",
  • "countyFipsCode": "36005",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/Addresses

Request Body schema:
addressID
required
string <uuid>
addressType
string (AddressTypes)
Enum: "Mailing" "Alternate" "Physical"
addressPrimaryInd
boolean or null
billingAddressInd
boolean or null
street1
string or null <= 50 characters
street2
string or null <= 50 characters
street3
string or null <= 50 characters
street4
string or null <= 50 characters
city
string or null <= 35 characters
state
string or null <= 2 characters ^[a-zA-Z]*$
zipCodeBaseFive
string or null <= 5 characters
zipCodePlusFour
string or null <= 4 characters ^\d*$
postalCode
string or null <= 10 characters ^\d*$
countryCode
string or null <= 2 characters
countyFipsCode
string or null <= 5 characters
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "addressID": "784c2e71-fb2f-4072-8e91-8256e177c41c",
  • "addressType": "Mailing",
  • "addressPrimaryInd": true,
  • "billingAddressInd": true,
  • "street1": "string",
  • "street2": "string",
  • "street3": "string",
  • "street4": "string",
  • "city": "NEW YORK",
  • "state": "NY",
  • "zipCodeBaseFive": "54321",
  • "zipCodePlusFour": "9876",
  • "postalCode": "234-7564",
  • "countryCode": "US",
  • "countyFipsCode": "36005",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

Documents

/api/Documents/Url/{entityID}/{documentID}

path Parameters
entityID
required
string <uuid>
documentID
required
string <uuid>

Responses

Response samples

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

/api/Documents/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/Documents

Request Body schema:
kycKybID
string or null <uuid>
documentSource
required
string <= 100 characters
documentType
required
string (DocumentTypes)
Enum: "A" "D" "O" "P" "S" "C"

A - Alien Registration number / Resident Card / Green Card D - Drivers License O - Other P - Passport S - State Identification Card C - Corporate ID / Resolution Number

documentCountryId
string or null <= 2 characters
documentStateProvinceId
string or null <= 4 characters
documentVerificationDate
required
string <date-time>
documentDescription
required
string <= 100 characters
documentNumber
required
string <= 20 characters
documentValidFromDate
required
string <date-time>
documentValidToDate
required
string <date-time>
uploadedFileName
required
string
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "kycKybID": "16e1847d-37fd-4f5a-8a3e-4934e271cc47",
  • "documentSource": "Chase bank",
  • "documentType": "A",
  • "documentCountryId": "US",
  • "documentStateProvinceId": "NY",
  • "documentVerificationDate": "2019-08-24T14:15:22Z",
  • "documentDescription": "Some description",
  • "documentNumber": "string",
  • "documentValidFromDate": "2019-08-24T14:15:22Z",
  • "documentValidToDate": "2019-08-24T14:15:22Z",
  • "uploadedFileName": "string",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/Documents

Request Body schema:
documentID
required
string <uuid>
documentSource
string or null <= 100 characters
documentType
string (DocumentTypes)
Enum: "A" "D" "O" "P" "S" "C"

A - Alien Registration number / Resident Card / Green Card D - Drivers License O - Other P - Passport S - State Identification Card C - Corporate ID / Resolution Number

documentCountryId
string or null <= 2 characters
documentStateProvinceId
string or null <= 4 characters
documentVerificationDate
string or null <date-time>
documentDescription
string or null <= 100 characters
documentNumber
string or null <= 20 characters
documentValidFromDate
string or null <date-time>
documentValidToDate
string or null <date-time>
uploadedFileName
string or null
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "documentID": "47014460-c810-4209-8376-6ba8b6b20de0",
  • "documentSource": "Chase bank",
  • "documentType": "A",
  • "documentCountryId": "US",
  • "documentStateProvinceId": "NY",
  • "documentVerificationDate": "2019-08-24T14:15:22Z",
  • "documentDescription": "Some description",
  • "documentNumber": "string",
  • "documentValidFromDate": "2019-08-24T14:15:22Z",
  • "documentValidToDate": "2019-08-24T14:15:22Z",
  • "uploadedFileName": "string",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

Emails

/api/Emails/{entityId}/{id}

path Parameters
entityId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

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

/api/Emails/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/Emails

Request Body schema:
emailAddress
required
string <email> <= 50 characters
emailClassification
required
string (EmailClassifications)
Enum: "Personal" "Corporate"
emailPrimaryInd
required
boolean
lastVerifiedDate
string or null <date-time>
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "emailAddress": "user@example.com",
  • "emailClassification": "Personal",
  • "emailPrimaryInd": true,
  • "lastVerifiedDate": "2019-08-24T14:15:22Z",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/Emails

Request Body schema:
emailID
required
string <uuid>
emailAddress
string or null <email> <= 50 characters
emailClassification
string (EmailClassifications)
Enum: "Personal" "Corporate"
emailPrimaryInd
boolean or null
lastVerifiedDate
string or null <date-time>
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "emailID": "0500c744-a78e-400e-ae17-f083c83cda4b",
  • "emailAddress": "user@example.com",
  • "emailClassification": "Personal",
  • "emailPrimaryInd": true,
  • "lastVerifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

Employments

/api/Employments/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/Employments

Request Body schema:
employer
required
string <= 100 characters
employmentIndustry
required
string <= 100 characters
occupation
required
string <= 100 characters
employmentTitle
required
string <= 100 characters
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "employer": "CFSB",
  • "employmentIndustry": "Banking",
  • "occupation": "Management",
  • "employmentTitle": "Project Manager",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/Employments

Request Body schema:
employmentID
required
string <uuid>
employer
string or null <= 100 characters
employmentIndustry
string or null <= 100 characters
occupation
string or null <= 100 characters
employmentTitle
string or null <= 100 characters
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "employmentID": "cd7608b9-ad4f-4cb1-ad23-0187706934ce",
  • "employer": "CFSB",
  • "employmentIndustry": "Banking",
  • "occupation": "Management",
  • "employmentTitle": "Project Manager",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

Entities

/api/Entities

Request Body schema:
parentEntityID
string or null <uuid>
entityClassification
required
string (EntityClassifications)
Enum: "Individual" "Corporate"
entityStatus
required
string (EntityStatuses)
Enum: "Inactive" "Active" "Restricted"
entityType
required
string (EntityTypes)
Enum: "IND" "CRP" "LLC" "LPR" "LLP" "GPR" "SPR" "NFP" "TRU" "EST" "MUN" "SubPartner"

IND - Individual CRP - Corporation LLC - Limited Liability Company LPR - Limited Partnership LLP - Limited Liability Partnership GPR - General Partnership SPR - Sole Proprietor NFP - Not-for-Profit TRU - Trust EST - Estate MUN - Municipality SubPartner - Sub Partner

entityFullName
required
string <= 100 characters
lastName
string or null <= 35 characters
middleName
string or null <= 35 characters
firstName
string or null <= 35 characters
taxId
required
string <= 35 characters
taxIdType
required
string (EntityTaxIdTypes)
Enum: "SSN" "EIN" "TIN"
taxResidencyCountryCode
required
string <= 3 characters
citizenship
string or null <= 3 characters
dateOfBirth
string or null <date-time>
customerNotes
string or null <= 100 characters
naics
string or null <= 6 characters ^\d*$
industryTypeDescription
string or null <= 100 characters
dateOfIncorporation
string or null <date-time>
companyWebsite
string or null <= 100 characters
merchantWebsite
string or null <= 100 characters
countryOfIncorporation
string or null <= 3 characters
corporateTitle
string or null <= 40 characters
isPrimaryLevel
required
boolean
entityFlexFields
string or null
Array of objects or null (CreateNestedEmployment)
required
Array of objects (CreateNestedAddress)
required
Array of objects (CreateNestedEmail)
required
Array of objects (CreateNestedEntityKycKyb)
required
Array of objects (CreateNestedPhoneNumber)
Array of objects or null (CreateNestedEntityCreditData)
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "parentEntityID": "113ae279-2a0d-420a-9899-d7ad2a295037",
  • "entityClassification": "Individual",
  • "entityStatus": "Inactive",
  • "entityType": "IND",
  • "entityFullName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "firstName": "string",
  • "taxId": "string",
  • "taxIdType": "SSN",
  • "taxResidencyCountryCode": "US",
  • "citizenship": "str",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "customerNotes": "Free form notes",
  • "naics": "123456",
  • "industryTypeDescription": "Banking",
  • "dateOfIncorporation": "2019-08-24T14:15:22Z",
  • "companyWebsite": "www.cfsb.com",
  • "merchantWebsite": "www.merchant.com",
  • "countryOfIncorporation": "US",
  • "corporateTitle": "CFSB",
  • "isPrimaryLevel": true,
  • "entityFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "employments": [
    ],
  • "addresses": [
    ],
  • "emails": [
    ],
  • "entityKycKybs": [
    ],
  • "phoneNumbers": [
    ],
  • "entityCreditData": [
    ],
  • "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/Entities

Request Body schema:
entityID
required
string <uuid>
parentEntityID
string or null <uuid>
entityStatus
string (EntityStatuses)
Enum: "Inactive" "Active" "Restricted"
entityType
string (EntityTypes)
Enum: "IND" "CRP" "LLC" "LPR" "LLP" "GPR" "SPR" "NFP" "TRU" "EST" "MUN" "SubPartner"

IND - Individual CRP - Corporation LLC - Limited Liability Company LPR - Limited Partnership LLP - Limited Liability Partnership GPR - General Partnership SPR - Sole Proprietor NFP - Not-for-Profit TRU - Trust EST - Estate MUN - Municipality SubPartner - Sub Partner

entityFullName
string or null <= 100 characters
lastName
string or null <= 35 characters
middleName
string or null <= 35 characters
firstName
string or null <= 35 characters
citizenship
string or null <= 3 characters
dateOfBirth
string or null <date-time>
customerNotes
string or null <= 100 characters
naics
string or null <= 6 characters ^\d*$
industryTypeDescription
string or null <= 100 characters
dateOfIncorporation
string or null <date-time>
companyWebsite
string or null <= 100 characters
merchantWebsite
string or null <= 100 characters
countryOfIncorporation
string or null <= 3 characters
corporateTitle
string or null <= 40 characters
isPrimaryLevel
boolean or null
entityFlexFields
string or null
Array of objects or null (UpdateEmployment)
Array of objects or null (UpdateAddress)
Array of objects or null (UpdateEmail)
Array of objects or null (UpdateEntityKycKyb)
Array of objects or null (UpdatePhoneNumber)
Array of objects or null (UpdateEntityCreditData)
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "parentEntityID": "113ae279-2a0d-420a-9899-d7ad2a295037",
  • "entityStatus": "Inactive",
  • "entityType": "IND",
  • "entityFullName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "firstName": "string",
  • "citizenship": "str",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "customerNotes": "Free form notes",
  • "naics": "123456",
  • "industryTypeDescription": "Banking",
  • "dateOfIncorporation": "2019-08-24T14:15:22Z",
  • "companyWebsite": "www.cfsb.com",
  • "merchantWebsite": "www.merchant.com",
  • "countryOfIncorporation": "US",
  • "corporateTitle": "CFSB",
  • "isPrimaryLevel": true,
  • "entityFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "employments": [
    ],
  • "addresses": [
    ],
  • "emails": [
    ],
  • "entityKycKybs": [
    ],
  • "phoneNumbers": [
    ],
  • "entityCreditData": [
    ],
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

/api/Entities/CreateEntityWithFiles

query Parameters
object (EntityWithFiles)
Request Body schema: multipart/form-data
files
Array of strings <binary> [ items <binary > ]

Responses

Response samples

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

/api/Entities/{id}/FullView

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
{
  • "partnerID": "ae461794-a7aa-4a5a-a2ed-164bbc7dd251",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "parentEntityID": "113ae279-2a0d-420a-9899-d7ad2a295037",
  • "entityClassification": "Individual",
  • "entityStatus": "Inactive",
  • "entityType": "IND",
  • "entityFullName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "firstName": "string",
  • "taxId": "string",
  • "taxIdType": "SSN",
  • "taxResidencyCountryCode": "US",
  • "citizenship": "str",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "customerNotes": "Free form notes",
  • "naics": "123456",
  • "industryTypeDescription": "Banking",
  • "dateOfIncorporation": "2019-08-24T14:15:22Z",
  • "companyWebsite": "www.cfsb.com",
  • "merchantWebsite": "www.merchant.com",
  • "countryOfIncorporation": "US",
  • "corporateTitle": "CFSB",
  • "isPrimaryLevel": true,
  • "entityFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "employments": [
    ],
  • "addresses": [
    ],
  • "emails": [
    ],
  • "entityKycKybs": [
    ],
  • "phoneNumbers": [
    ],
  • "entityCreditData": [
    ]
}

/api/Entities/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/Entities/{id}/Deactivate

path Parameters
id
required
string <uuid>

Responses

Response samples

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

/api/Entities/{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": {
    }
}

EntityCreditData

/api/EntityCreditData/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/EntityCreditData

Request Body schema:
ficoScore
required
integer <int32> [ 300 .. 850 ]
ficoVersion
required
string <= 10 characters
ficoDate
required
string <date-time>
vantageScore
required
integer <int32> [ 300 .. 850 ]
vantageScoreVersion
required
string <= 10 characters
vantageScoreDate
required
string <date-time>
creditGrade
required
string <= 10 characters
initialFraudAlertFlag
required
boolean
extendedFraudAlertFlag
required
boolean
addressDiscrepancyFlag
required
boolean
creditFreezeFlag
required
boolean
priorLoanFlag
required
boolean
debtUtilization
required
number <double>
totalRevolvingDebt
required
number <double>
creditInquiries12Months
required
integer <int32>
dqPast24Months
required
integer <int32>
accountsOpenedPast24Months
required
integer <int32>
openCreditLines
required
integer <int32>
collectionsExcludingMedical
required
integer <int32>
publicRecordsOnFile
required
integer <int32>
monthsSinceLastRecord
required
integer <int32>
homeownerFlag
required
boolean
employmentLength
required
number <double>
employer
required
string <= 50 characters
annualIncome
required
number <double>
netDisposableIncome
required
number <double>
preDTIExMortgage
required
number <double> [ -9999.999999 .. 9999.999999 ]
preDTIInMortgage
required
number <double> [ -9999.999999 .. 9999.999999 ]
preDTIDate
required
string <date-time>
postDTIExMortgage
required
number <double> [ -9999.999999 .. 9999.999999 ]
postDTIInMortgage
required
number <double> [ -9999.999999 .. 9999.999999 ]
postDTIDate
required
string <date-time>
adjustedGrossIncome
required
number <double>
liquidAssets
required
number <double>
forecastDSCR
required
number <double> [ -999.99 .. 999.99 ]
monthsInExistence
required
integer <int32>
numberOfCorporateLocations
required
integer <int32>
overdraftPast12Months
required
integer <int32>
numberOfEmployees
required
integer <int32>
priorYearSales
required
number <double>
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "ficoScore": 350,
  • "ficoVersion": "2.0",
  • "ficoDate": "2019-08-24T14:15:22Z",
  • "vantageScore": 420,
  • "vantageScoreVersion": "1.2",
  • "vantageScoreDate": "2019-08-24T14:15:22Z",
  • "creditGrade": "Good",
  • "initialFraudAlertFlag": true,
  • "extendedFraudAlertFlag": true,
  • "addressDiscrepancyFlag": true,
  • "creditFreezeFlag": true,
  • "priorLoanFlag": true,
  • "debtUtilization": 35.7,
  • "totalRevolvingDebt": 35.7,
  • "creditInquiries12Months": 3,
  • "dqPast24Months": 3,
  • "accountsOpenedPast24Months": 2,
  • "openCreditLines": 1,
  • "collectionsExcludingMedical": 0,
  • "publicRecordsOnFile": 3,
  • "monthsSinceLastRecord": 3,
  • "homeownerFlag": true,
  • "employmentLength": 24,
  • "employer": "CFSB",
  • "annualIncome": 120000,
  • "netDisposableIncome": 100000,
  • "preDTIExMortgage": 30000,
  • "preDTIInMortgage": 40000,
  • "preDTIDate": "2019-08-24T14:15:22Z",
  • "postDTIExMortgage": 5000,
  • "postDTIInMortgage": 6000,
  • "postDTIDate": "2019-08-24T14:15:22Z",
  • "adjustedGrossIncome": 100000,
  • "liquidAssets": 30000,
  • "forecastDSCR": 0.2,
  • "monthsInExistence": 30,
  • "numberOfCorporateLocations": 5,
  • "overdraftPast12Months": 1,
  • "numberOfEmployees": 300,
  • "priorYearSales": 200000,
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/EntityCreditData

Request Body schema:
entityCreditDataID
required
string <uuid>
ficoScore
integer or null <int32> [ 300 .. 850 ]
ficoVersion
string or null <= 10 characters
ficoDate
string or null <date-time>
vantageScore
integer or null <int32> [ 300 .. 850 ]
vantageScoreVersion
string or null <= 10 characters
vantageScoreDate
string or null <date-time>
creditGrade
string or null <= 10 characters
initialFraudAlertFlag
boolean or null
extendedFraudAlertFlag
boolean or null
addressDiscrepancyFlag
boolean or null
creditFreezeFlag
boolean or null
priorLoanFlag
boolean or null
debtUtilization
number or null <double>
totalRevolvingDebt
number or null <double>
creditInquiries12Months
integer or null <int32>
dqPast24Months
integer or null <int32>
accountsOpenedPast24Months
integer or null <int32>
openCreditLines
integer or null <int32>
collectionsExcludingMedical
integer or null <int32>
publicRecordsOnFile
integer or null <int32>
monthsSinceLastRecord
integer or null <int32>
homeownerFlag
boolean or null
employmentLength
number or null <double>
employer
string or null <= 50 characters
annualIncome
number or null <double>
netDisposableIncome
number or null <double>
preDTIExMortgage
number or null <double> [ -9999.999999 .. 9999.999999 ]
preDTIInMortgage
number or null <double> [ -9999.999999 .. 9999.999999 ]
preDTIDate
string or null <date-time>
postDTIExMortgage
number or null <double> [ -9999.999999 .. 9999.999999 ]
postDTIInMortgage
number or null <double> [ -9999.999999 .. 9999.999999 ]
postDTIDate
string or null <date-time>
adjustedGrossIncome
number or null <double>
liquidAssets
number or null <double>
forecastDSCR
number or null <double> [ -999.99 .. 999.99 ]
monthsInExistence
integer or null <int32>
numberOfCorporateLocations
integer or null <int32>
overdraftPast12Months
integer or null <int32>
numberOfEmployees
integer or null <int32>
priorYearSales
number or null <double>
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "entityCreditDataID": "d64cb84b-498e-4670-9160-86d4983a9036",
  • "ficoScore": 350,
  • "ficoVersion": "2.0",
  • "ficoDate": "2019-08-24T14:15:22Z",
  • "vantageScore": 420,
  • "vantageScoreVersion": "1.2",
  • "vantageScoreDate": "2019-08-24T14:15:22Z",
  • "creditGrade": "Good",
  • "initialFraudAlertFlag": true,
  • "extendedFraudAlertFlag": true,
  • "addressDiscrepancyFlag": true,
  • "creditFreezeFlag": true,
  • "priorLoanFlag": true,
  • "debtUtilization": 35.7,
  • "totalRevolvingDebt": 35.7,
  • "creditInquiries12Months": 3,
  • "dqPast24Months": 3,
  • "accountsOpenedPast24Months": 2,
  • "openCreditLines": 1,
  • "collectionsExcludingMedical": 0,
  • "publicRecordsOnFile": 3,
  • "monthsSinceLastRecord": 3,
  • "homeownerFlag": true,
  • "employmentLength": 24,
  • "employer": "CFSB",
  • "annualIncome": 120000,
  • "netDisposableIncome": 100000,
  • "preDTIExMortgage": 30000,
  • "preDTIInMortgage": 40000,
  • "preDTIDate": "2019-08-24T14:15:22Z",
  • "postDTIExMortgage": 5000,
  • "postDTIInMortgage": 6000,
  • "postDTIDate": "2019-08-24T14:15:22Z",
  • "adjustedGrossIncome": 100000,
  • "liquidAssets": 30000,
  • "forecastDSCR": 0.2,
  • "monthsInExistence": 30,
  • "numberOfCorporateLocations": 5,
  • "overdraftPast12Months": 1,
  • "numberOfEmployees": 300,
  • "priorYearSales": 200000,
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

EntityKycKybs

/api/EntityKycKybs/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/EntityKycKybs

Request Body schema:
kycKybMethodType
required
string (KycKybMethodTypes)
Enum: "Documentary" "NonDocumentary" "Exception" "Failed"

Documentary - Documentary verification consists of physically reviewing an unexpired government-issued photo identification(“ID”), comparing the ID photo to the consumer, and verifying that the information on the ID matches the information provided by the consumer. NonDocumentary - Customers may rely upon the use of non-documentary methods for verifying an identity, especially when the account is not opened via face-to-face contact with the customer. This method involves comparing information provided by the consumer with information obtained from consumer reporting agencies or third-party vendor solutions (e.g., LexisNexis, Experian, or IDology, etc). CFSB must review and approve the process used for non-documentary verification methods. Exception - Exceptional verifications would be outside of either a documentary or non-documentary review; such as when additional documentation or verification is performed. Failed - Failed verification denotes where the verification could not be performed, the account should be inactive, closed, or otherwise not active status when KYC verification fails.

kycKybVerificationStatus
required
string (KycKybVerificationStatuses)
Enum: "Passed" "Failed" "Canceled" "Incomplete"
kycKybStatusReason
required
string <= 200 characters
kycVerificationDate
required
string <date-time>
kycVerificationDetails
required
string <= 100 characters
ofacVerificationDate
required
string <date-time>
ofacStatusVerificationDetails
required
string <= 100 characters
ofacStatus
required
string (OfacStatuses)
Enum: "Passed" "Failed"
pepVerificationDate
required
string <date-time>
pepStatusVerificationDetails
required
string <= 100 characters
pepFlag
required
boolean
publiclyTradedInd
required
boolean
stockSymbol
string or null <= 4 characters
stockExchange
string or null <= 15 characters
Array of objects or null (CreateNestedDocument)
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "kycKybMethodType": "Documentary",
  • "kycKybVerificationStatus": "Passed",
  • "kycKybStatusReason": "Invalid document",
  • "kycVerificationDate": "2019-08-24T14:15:22Z",
  • "kycVerificationDetails": "Outdated document",
  • "ofacVerificationDate": "2019-08-24T14:15:22Z",
  • "ofacStatusVerificationDetails": "Data is invalid",
  • "ofacStatus": "Passed",
  • "pepVerificationDate": "2019-08-24T14:15:22Z",
  • "pepStatusVerificationDetails": "Data is invalid",
  • "pepFlag": true,
  • "publiclyTradedInd": true,
  • "stockSymbol": "MSFT",
  • "stockExchange": "NASDAQ",
  • "documents": [
    ],
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/EntityKycKybs

Request Body schema:
entityKycKybID
required
string <uuid>
kycKybMethodType
string (KycKybMethodTypes)
Enum: "Documentary" "NonDocumentary" "Exception" "Failed"

Documentary - Documentary verification consists of physically reviewing an unexpired government-issued photo identification(“ID”), comparing the ID photo to the consumer, and verifying that the information on the ID matches the information provided by the consumer. NonDocumentary - Customers may rely upon the use of non-documentary methods for verifying an identity, especially when the account is not opened via face-to-face contact with the customer. This method involves comparing information provided by the consumer with information obtained from consumer reporting agencies or third-party vendor solutions (e.g., LexisNexis, Experian, or IDology, etc). CFSB must review and approve the process used for non-documentary verification methods. Exception - Exceptional verifications would be outside of either a documentary or non-documentary review; such as when additional documentation or verification is performed. Failed - Failed verification denotes where the verification could not be performed, the account should be inactive, closed, or otherwise not active status when KYC verification fails.

kycKybVerificationStatus
string (KycKybVerificationStatuses)
Enum: "Passed" "Failed" "Canceled" "Incomplete"
kycKybStatusReason
string or null <= 200 characters
kycVerificationDate
string or null <date-time>
kycVerificationDetails
string or null <= 100 characters
ofacVerificationDate
string or null <date-time>
ofacStatusVerificationDetails
string or null <= 100 characters
ofacStatus
string (OfacStatuses)
Enum: "Passed" "Failed"
pepVerificationDate
string or null <date-time>
pepStatusVerificationDetails
string or null <= 100 characters
pepFlag
boolean or null
publiclyTradedInd
boolean or null
stockSymbol
string or null <= 4 characters
stockExchange
string or null <= 15 characters
Array of objects or null (UpdateDocument)
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "entityKycKybID": "5f2129e1-7073-4cec-b754-c8cdd39eafcb",
  • "kycKybMethodType": "Documentary",
  • "kycKybVerificationStatus": "Passed",
  • "kycKybStatusReason": "Invalid document",
  • "kycVerificationDate": "2019-08-24T14:15:22Z",
  • "kycVerificationDetails": "Outdated document",
  • "ofacVerificationDate": "2019-08-24T14:15:22Z",
  • "ofacStatusVerificationDetails": "Data is invalid",
  • "ofacStatus": "Passed",
  • "pepVerificationDate": "2019-08-24T14:15:22Z",
  • "pepStatusVerificationDetails": "Data is invalid",
  • "pepFlag": true,
  • "publiclyTradedInd": true,
  • "stockSymbol": "MSFT",
  • "stockExchange": "NASDAQ",
  • "documents": [
    ],
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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

PhoneNumbers

/api/PhoneNumbers/{entityId}/{id}

path Parameters
entityId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

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

/api/PhoneNumbers/{entityId}

path Parameters
entityId
required
string <uuid>

Responses

Response samples

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

/api/PhoneNumbers

Request Body schema:
phoneCountryCode
required
string <= 4 characters
phoneNumber
required
string <= 12 characters
phoneExtension
string or null <= 5 characters
phoneClassification
required
string (PhoneClassifications)
Enum: "Home" "Work" "Mobile"
phonePrimaryInd
required
boolean
lastVerifiedDate
string or null <date-time>
entityID
string or null <uuid>
lastModifiedByPartnerUtcDt
string or null <date-time>
partnerID
string or null <uuid>

Required for internal users only

Responses

Request samples

Content type
{
  • "phoneCountryCode": "+1",
  • "phoneNumber": "string",
  • "phoneExtension": "234",
  • "phoneClassification": "Home",
  • "phonePrimaryInd": true,
  • "lastVerifiedDate": "2019-08-24T14:15:22Z",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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/PhoneNumbers

Request Body schema:
phoneNumberID
required
string <uuid>
phoneCountryCode
string or null <= 4 characters
phoneNumber
string or null <= 12 characters
phoneExtension
string or null <= 5 characters
phoneClassification
string (PhoneClassifications)
Enum: "Home" "Work" "Mobile"
phonePrimaryInd
boolean or null
lastVerifiedDate
string or null <date-time>
lastModifiedByPartnerUtcDt
string or null <date-time>

Responses

Request samples

Content type
{
  • "phoneNumberID": "8e8a6915-9a9e-405d-a2ed-493916165858",
  • "phoneCountryCode": "+1",
  • "phoneNumber": "string",
  • "phoneExtension": "234",
  • "phoneClassification": "Home",
  • "phonePrimaryInd": true,
  • "lastVerifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z"
}

Response samples

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