Community Federal Savings Bank
API docs by Redocly

Entities API Docs (v1.12.12)

Download OpenAPI specification:Download

Addresses

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

path Parameters
entityId
required
string <uuid>
id
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/Addresses

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
addressType
string (AddressTypes)
Enum: "Mailing" "Alternate" "Physical"
addressPrimaryInd
boolean
billingAddressInd
boolean
city
string <= 35 characters
state
string <= 2 characters ^[a-zA-Z]*$
zipCodeBaseFive
string <= 5 characters
zipCodePlusFour
string <= 4 characters ^\d*$
postalCode
string <= 10 characters ^\d*$
countryCode
string <= 2 characters
countyFipsCode
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,
  • "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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
addressID
string <uuid>
addressType
string (AddressTypes)
Enum: "Mailing" "Alternate" "Physical"
addressPrimaryInd
boolean or null
billingAddressInd
boolean or null
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,
  • "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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/Documents

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
kycKybID
string or null <uuid>
documentSource
string <= 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 <date-time>
documentDescription
string <= 100 characters
documentValidFromDate
string <date-time>
documentValidToDate
string <date-time>
uploadedFileName
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",
  • "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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
documentID
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
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",
  • "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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/Emails

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
emailClassification
string (EmailClassifications)
Enum: "Personal" "Business"
emailPrimaryInd
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
{
  • "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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
emailID
string <uuid>
emailClassification
string (EmailClassifications)
Enum: "Personal" "Business"
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",
  • "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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/Employments

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
employer
string <= 100 characters
employmentIndustry
string <= 100 characters
occupation
string <= 100 characters
employmentTitle
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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
employmentID
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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
entityClassification
string (EntityClassifications)
Enum: "Individual" "Business"
entityStatus
string (EntityStatuses)
Enum: "Inactive" "Active" "Restricted"
entityType
string (EntityTypes)
Enum: "IND" "CRP" "LLC" "LPR" "LLP" "GPR" "SPR" "NFP" "TRU" "EST" "MUN"

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

taxIdType
string (EntityTaxIdTypes)
Enum: "SSN" "EIN" "TIN"
taxResidencyCountryCode
string <= 3 characters
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
businessTitle
string or null <= 40 characters
entityFlexFields
string or null
Array of objects or null (CreateNestedEmployment)
Array of objects (CreateNestedAddress)
Array of objects (CreateNestedEmail)
Array of objects (CreateNestedEntityKycKyb)
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
{
  • "entityClassification": "Individual",
  • "entityStatus": "Inactive",
  • "entityType": "IND",
  • "taxIdType": "SSN",
  • "taxResidencyCountryCode": "US",
  • "customerNotes": "Free form notes",
  • "naics": "123456",
  • "industryTypeDescription": "Banking",
  • "dateOfIncorporation": "2019-08-24T14:15:22Z",
  • "companyWebsite": "www.cfsb.com",
  • "merchantWebsite": "www.merchant.com",
  • "countryOfIncorporation": "US",
  • "businessTitle": "CFSB",
  • "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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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

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

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
businessTitle
string or null <= 40 characters
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",
  • "entityStatus": "Inactive",
  • "entityType": "IND",
  • "customerNotes": "Free form notes",
  • "naics": "123456",
  • "industryTypeDescription": "Banking",
  • "dateOfIncorporation": "2019-08-24T14:15:22Z",
  • "companyWebsite": "www.cfsb.com",
  • "merchantWebsite": "www.merchant.com",
  • "countryOfIncorporation": "US",
  • "businessTitle": "CFSB",
  • "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)
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema: multipart/form-data
files
Array of strings <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/{entityId}/FullView

path Parameters
entityId
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

Content type
{
  • "partnerID": "ae461794-a7aa-4a5a-a2ed-164bbc7dd251",
  • "lastModifiedByPartnerUtcDt": "2019-08-24T14:15:22Z",
  • "entityID": "166ced5a-0316-4f26-8b7d-6aebbf5a983e",
  • "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",
  • "businessTitle": "CFSB",
  • "entityFlexFields": "{ \"field1\": \"field value\", \"field2\": 123 }",
  • "employments": [
    ],
  • "addresses": [
    ],
  • "emails": [
    ],
  • "entityKycKybs": [
    ],
  • "phoneNumbers": [
    ],
  • "entityCreditData": [
    ]
}

/api/Entities/{entityId}

path Parameters
entityId
required
string <uuid>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/EntityCreditData

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
entityCreditDataID
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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/EntityKycKybs

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
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 <= 200 characters
kycVerificationDate
string <date-time>
kycVerificationDetails
string <= 100 characters
ofacVerificationDate
string <date-time>
ofacStatusVerificationDetails
string <= 100 characters
ofacStatus
string (OfacStatuses)
Enum: "Passed" "Failed"
pepVerificationDate
string <date-time>
pepStatusVerificationDetails
string <= 100 characters
pepFlag
boolean
publiclyTradedInd
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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
entityKycKybID
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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

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>
header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Responses

Response samples

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

/api/PhoneNumbers

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
phoneCountryCode
string <= 4 characters
phoneExtension
string or null <= 5 characters
phoneClassification
string (PhoneClassifications)
Enum: "Home" "Work" "Mobile"
phonePrimaryInd
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",
  • "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

header Parameters
X-Api-Mode
string
Default: webhooks
Examples:
  • http -
  • webhooks -

Allows to change the API operation mode: HTTP or Webhooks

Request Body schema:
phoneNumberID
string <uuid>
phoneCountryCode
string or null <= 4 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",
  • "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"
}