PAF Core Banking Management System (1.2.1)

Download OpenAPI specification:Download

CBMS API description

Utils API

Get states by country code

path Parameters

country

required

string

Example: US

ISO 3166-1 alpha-2 country code

Responses

Response samples

200

Content type

application/json

[{"title": "string",
"value": "string"
}
]

Get cities by country code and state

path Parameters

country required	string Example: US ISO 3166-1 alpha-2 country code
state required	string^[A-Z]{2}$ Example: NY State code (2 characters)

Responses

Response samples

200

Content type

application/json

[{"title": "string",
"value": "string"
}
]

Upload Documents

Upload a Document

Authorizations:

bearer

Request Body schema: multipart/form-data
required

frontSide required	string <binary>
backSide	string <binary>
customerId required	string Id of the customer to whom the document belongs.

Responses

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerId": "string",
"frontSideUrl": "string",
"backSideUrl": "string",
"id": { }
}

Find all Uploaded Documents

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"uploadedDocuments": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerId": "string",
"frontSideUrl": "string",
"backSideUrl": "string",
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find a specific Uploaded Document

Authorizations:

bearer

path Parameters

uploadedDocumentId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerId": "string",
"frontSideUrl": "string",
"backSideUrl": "string",
"id": { }
}

Customers

Create a Customer

Authorizations:

bearer

Request Body schema: application/json
required

customerType

string (CustomerType)

Enum: "INDIVIDUAL" "COMPANY"

IndividualCustomer (object) or CompanyCustomer (object)

One of

firstName required	string
middleName required	string
lastName required	string
dateOfBirth required	string <date-time>
citizenship required	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
taxIdNumber	string/^[0-9]{9,9}$/
passportIdNumber	string
taxIdCountry required	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
taxState	string If Tax ID Country is US, then Tax State is required and should be ISO 3166-2 format string
phoneNumber required	string
email required	string

userId

string

object (Address)

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

isRegisteredAndPrimaryAddressSame

boolean

Is registered and primary address same

object

The official address registered by the business in the State of organization.

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

isPostalAndPrimaryAddressSame

boolean

Is postal and primary address same

object (Address)

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

metadata

object

Responses

Request samples

Payload

Content type

application/json

{"customerType": "INDIVIDUAL",
"profile": {"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"citizenship": "AD",
"taxIdNumber": "string",
"passportIdNumber": "string",
"taxIdCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"userId": "string",
"primaryAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isRegisteredAndPrimaryAddressSame": true,
"registeredAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isPostalAndPrimaryAddressSame": true,
"postalAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"metadata": { }
}

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerType": "INDIVIDUAL",
"profile": {"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"citizenship": "AD",
"taxIdNumber": "string",
"passportIdNumber": "string",
"taxIdCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"resourceRelationships": {"individualDueDiligenceId": "string",
"companyDueDiligenceId": "string",
"companyAssociationId": "string",
"opportunityAccountId": "string",
"standardAccountId": "string",
"partnerAccountId": "string",
"bankingApplicationId": "string",
"counterpartyIds": ["string"
]
},
"agreementDocuments": {"agreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"partnerAgreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isSigned": true
},
"pendingActions": ["PERSONAL_INFORMATION_REQUIRED"
],
"userId": "string",
"primaryAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isRegisteredAndPrimaryAddressSame": true,
"registeredAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isPostalAndPrimaryAddressSame": true,
"postalAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"metadata": { },
"id": { }
}

Find all Customers

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"customers": [{ }
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find the Resource Relationships for Customers

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)

Responses

Response samples

200

Content type

application/json

{"customers": [{"customerId": "string",
"userId": "string",
"resourceRelationships": {"individualDueDiligenceId": "string",
"companyDueDiligenceId": "string",
"companyAssociationId": "string",
"opportunityAccountId": "string",
"standardAccountId": "string",
"partnerAccountId": "string",
"bankingApplicationId": "string",
"counterpartyIds": ["string"
]
}
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find the Resource Relationship for a Customer

Authorizations:

bearer

path Parameters

userId

required

string

Responses

Response samples

200

Content type

application/json

{"customerId": "string",
"userId": "string",
"resourceRelationships": {"individualDueDiligenceId": "string",
"companyDueDiligenceId": "string",
"companyAssociationId": "string",
"opportunityAccountId": "string",
"standardAccountId": "string",
"partnerAccountId": "string",
"bankingApplicationId": "string",
"counterpartyIds": ["string"
]
}
}

Find a specific Customer by ID

Authorizations:

bearer

path Parameters

customerId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerType": "INDIVIDUAL",
"profile": {"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"citizenship": "AD",
"taxIdNumber": "string",
"passportIdNumber": "string",
"taxIdCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"resourceRelationships": {"individualDueDiligenceId": "string",
"companyDueDiligenceId": "string",
"companyAssociationId": "string",
"opportunityAccountId": "string",
"standardAccountId": "string",
"partnerAccountId": "string",
"bankingApplicationId": "string",
"counterpartyIds": ["string"
]
},
"agreementDocuments": {"agreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"partnerAgreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isSigned": true
},
"pendingActions": ["PERSONAL_INFORMATION_REQUIRED"
],
"userId": "string",
"primaryAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isRegisteredAndPrimaryAddressSame": true,
"registeredAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isPostalAndPrimaryAddressSame": true,
"postalAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"metadata": { },
"id": { }
}

Update a specific Customer

Authorizations:

bearer

path Parameters

customerId

required

string

Request Body schema: application/json
required

customerType

string (CustomerType)

Enum: "INDIVIDUAL" "COMPANY"

profile

object

object (Address)

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

isRegisteredAndPrimaryAddressSame

boolean

Is registered and primary address same

object

The official address registered by the business in the State of organization.

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

isPostalAndPrimaryAddressSame

boolean

Is postal and primary address same

object (Address)

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

metadata

object

Responses

Request samples

Payload

Content type

application/json

{"customerType": "INDIVIDUAL",
"profile": { },
"primaryAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isRegisteredAndPrimaryAddressSame": true,
"registeredAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isPostalAndPrimaryAddressSame": true,
"postalAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"metadata": { }
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerType": "INDIVIDUAL",
"profile": {"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"citizenship": "AD",
"taxIdNumber": "string",
"passportIdNumber": "string",
"taxIdCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"resourceRelationships": {"individualDueDiligenceId": "string",
"companyDueDiligenceId": "string",
"companyAssociationId": "string",
"opportunityAccountId": "string",
"standardAccountId": "string",
"partnerAccountId": "string",
"bankingApplicationId": "string",
"counterpartyIds": ["string"
]
},
"agreementDocuments": {"agreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"partnerAgreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isSigned": true
},
"pendingActions": ["PERSONAL_INFORMATION_REQUIRED"
],
"userId": "string",
"primaryAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isRegisteredAndPrimaryAddressSame": true,
"registeredAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isPostalAndPrimaryAddressSame": true,
"postalAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"metadata": { },
"id": { }
}

Fetch Onboarding Agreement for customer by customer id

Authorizations:

bearer

path Parameters

customerId

required

string

Responses

Response samples

200

Content type

application/json

"string"

Sign Onboarding Agreement for customer by customer id

Authorizations:

bearer

path Parameters

customerId

required

string

Request Body schema: application/json
required

partnerAgreementDocId

string

Responses

Request samples

Payload

Content type

application/json

{"partnerAgreementDocId": "string"
}

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"customerType": "INDIVIDUAL",
"profile": {"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22Z",
"citizenship": "AD",
"taxIdNumber": "string",
"passportIdNumber": "string",
"taxIdCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"resourceRelationships": {"individualDueDiligenceId": "string",
"companyDueDiligenceId": "string",
"companyAssociationId": "string",
"opportunityAccountId": "string",
"standardAccountId": "string",
"partnerAccountId": "string",
"bankingApplicationId": "string",
"counterpartyIds": ["string"
]
},
"agreementDocuments": {"agreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"partnerAgreementDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isSigned": true
},
"pendingActions": ["PERSONAL_INFORMATION_REQUIRED"
],
"userId": "string",
"primaryAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isRegisteredAndPrimaryAddressSame": true,
"registeredAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isPostalAndPrimaryAddressSame": true,
"postalAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"metadata": { },
"id": { }
}

Get the Pending Actions

Authorizations:

bearer

path Parameters

customerId

required

string

Responses

Response samples

200

Content type

application/json

{"pendingActions": ["string"
]
}

Company Association

Create a Company Association

Authorizations:

bearer

Request Body schema: application/json
required

Array of objects (CreateAssociatedPartyDto)

Array

associatedPartyTypes	Array of arrays (AssociatedPartyTypes) Items Enum: "FORMATION_OFFICER" "EXECUTIVE_OFFICER" "SIGNATORY" "TRUSTEE" "KNOWN_GRANTOR" "KNOWN_BENEFICIARY" "BENEFICIAL_OWNER" "ACCOUNT_OWNER"
	IndividualInformationProfileDto (object) or EntityInformationProfileDto (object)
beneficialOwnerId	string
isIndividualOwner	boolean
	object (CompanyAssociationAddress)
occupation	string
occupationTitle	string
	object (CompanyAssociationAddress)
isAddressProofSkipped	boolean
isHaveRelationWithPEP	boolean
countryOfPEP	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
relationWithPEP	string
hasCertification	boolean
certificationDetails	string
	object (IdentificationDocumentArgsDto)
	object (ProofOfAddressDocumentArgsDto)
	Array of objects (DefaultDocumentArgsDto)

customerId

required

string

object (BeneficialOwnerCertification)

name required	string
signature required	string
date required	string <date-time>
entityIdentifier required	string Legal Entity Identifier (TIN/EIN)

Responses

Request samples

Payload

Content type

application/json

{"associatedParties": [{"associatedPartyTypes": ["FORMATION_OFFICER"
],
"profile": {"ownershipType": "DIRECTLY",
"shareOwnership": 0,
"llcMembership": 0,
"partnershipAllocation": 0,
"other": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isUsPerson": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"taxCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string",
"nonUsTaxIdInfo": {"passportId": {"documentType": "string",
"uploadedDocumentId": "string"
},
"countryOfIssuance": "AD",
"passportNumber": "string"
}
},
"beneficialOwnerId": "string",
"isIndividualOwner": true,
"primaryResidentialAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"occupation": "string",
"occupationTitle": "string",
"primaryBusinessAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isAddressProofSkipped": true,
"isHaveRelationWithPEP": true,
"countryOfPEP": "AD",
"relationWithPEP": "string",
"hasCertification": true,
"certificationDetails": "string",
"identificationDoc": {"documentType": "DRIVER_LICENSE",
"uploadedDocumentId": "string"
},
"proofOfAddressDoc": {"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string"
},
"businessEntityFormationAndGoverningDocs": [{"documentType": "string",
"uploadedDocumentId": "string"
}
]
}
],
"customerId": "string",
"beneficialOwnerCertification": {"name": "string",
"signature": "string",
"date": "2019-08-24T14:15:22Z",
"entityIdentifier": "string"
}
}

Response samples

201

Content type

application/json

{"companyAssociations": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["ASSOCIATED_PARTY_REQUIRED"
],
"customerId": "string",
"associatedPartyIds": ["string"
],
"beneficialOwnerCertification": {"name": "string",
"signature": "string",
"date": "2019-08-24T14:15:22Z",
"entityIdentifier": "string"
},
"id": { }
},
"associatedParties": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"associatedPartyTypes": ["FORMATION_OFFICER"
],
"profile": {"ownershipType": "DIRECTLY",
"shareOwnership": 0,
"llcMembership": 0,
"partnershipAllocation": 0,
"other": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isUsPerson": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"nonUsTaxIdInfo": {"passportNumber": "string",
"countryOfIssuance": "AD",
"passportId": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
},
"taxCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"identificationDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"businessEntityFormationAndGoverningDocs": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"companyAssociationId": "string",
"customerId": "string",
"beneficialOwnerId": "string",
"isIndividualOwner": true,
"primaryResidentialAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"occupation": "string",
"occupationTitle": "string",
"primaryBusinessAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isAddressProofSkipped": true,
"isHaveRelationWithPEP": true,
"countryOfPEP": "AD",
"relationWithPEP": "string",
"hasCertification": true,
"certificationDetails": "string",
"metadata": { },
"pendingActions": { },
"id": { }
}
]
}

Find all Company Associations

Authorizations:

bearer

query Parameters

	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"companyAssociations": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["ASSOCIATED_PARTY_REQUIRED"
],
"customerId": "string",
"associatedPartyIds": ["string"
],
"beneficialOwnerCertification": {"name": "string",
"signature": "string",
"date": "2019-08-24T14:15:22Z",
"entityIdentifier": "string"
},
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find all Company Associated Parties

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"associatedParties": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"associatedPartyTypes": ["FORMATION_OFFICER"
],
"profile": {"ownershipType": "DIRECTLY",
"shareOwnership": 0,
"llcMembership": 0,
"partnershipAllocation": 0,
"other": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isUsPerson": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"nonUsTaxIdInfo": {"passportNumber": "string",
"countryOfIssuance": "AD",
"passportId": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
},
"taxCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"identificationDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"businessEntityFormationAndGoverningDocs": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"companyAssociationId": "string",
"customerId": "string",
"beneficialOwnerId": "string",
"isIndividualOwner": true,
"primaryResidentialAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"occupation": "string",
"occupationTitle": "string",
"primaryBusinessAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isAddressProofSkipped": true,
"isHaveRelationWithPEP": true,
"countryOfPEP": "AD",
"relationWithPEP": "string",
"hasCertification": true,
"certificationDetails": "string",
"metadata": { },
"pendingActions": { },
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find a specific Company Association by ID

Authorizations:

bearer

path Parameters

companyAssociationId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["ASSOCIATED_PARTY_REQUIRED"
],
"customerId": "string",
"associatedPartyIds": ["string"
],
"beneficialOwnerCertification": {"name": "string",
"signature": "string",
"date": "2019-08-24T14:15:22Z",
"entityIdentifier": "string"
},
"id": { }
}

Get the Pending Actions

Authorizations:

bearer

path Parameters

companyAssociationId

required

string

Responses

Find the specific Company Associated Party

Authorizations:

bearer

path Parameters

associatedPartyId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"associatedPartyTypes": ["FORMATION_OFFICER"
],
"profile": {"ownershipType": "DIRECTLY",
"shareOwnership": 0,
"llcMembership": 0,
"partnershipAllocation": 0,
"other": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isUsPerson": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"nonUsTaxIdInfo": {"passportNumber": "string",
"countryOfIssuance": "AD",
"passportId": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
},
"taxCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"identificationDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"businessEntityFormationAndGoverningDocs": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"companyAssociationId": "string",
"customerId": "string",
"beneficialOwnerId": "string",
"isIndividualOwner": true,
"primaryResidentialAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"occupation": "string",
"occupationTitle": "string",
"primaryBusinessAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isAddressProofSkipped": true,
"isHaveRelationWithPEP": true,
"countryOfPEP": "AD",
"relationWithPEP": "string",
"hasCertification": true,
"certificationDetails": "string",
"metadata": { },
"pendingActions": { },
"id": { }
}

Delete the Associated Party For a specific Company Association

Authorizations:

bearer

path Parameters

associatedPartyId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Update the Beneficial Owner Certification for a specific Company Association

Authorizations:

bearer

path Parameters

companyAssociationId

required

string

Request Body schema: application/json
required

object (BeneficialOwnerCertification)

name required	string
signature required	string
date required	string <date-time>
entityIdentifier required	string Legal Entity Identifier (TIN/EIN)

Responses

Request samples

Payload

Content type

application/json

{"beneficialOwnerCertification": {"name": "string",
"signature": "string",
"date": "2019-08-24T14:15:22Z",
"entityIdentifier": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["ASSOCIATED_PARTY_REQUIRED"
],
"customerId": "string",
"associatedPartyIds": ["string"
],
"beneficialOwnerCertification": {"name": "string",
"signature": "string",
"date": "2019-08-24T14:15:22Z",
"entityIdentifier": "string"
},
"id": { }
}

Upsert the Associated Party for a specific Company Association

Authorizations:

bearer

path Parameters

companyAssociationId

required

string

Request Body schema: application/json
required

associatedPartyTypes

Array of arrays (AssociatedPartyTypes)

Items Enum: "FORMATION_OFFICER" "EXECUTIVE_OFFICER" "SIGNATORY" "TRUSTEE" "KNOWN_GRANTOR" "KNOWN_BENEFICIARY" "BENEFICIAL_OWNER" "ACCOUNT_OWNER"

IndividualInformationProfileDto (object) or EntityInformationProfileDto (object)

One of

ownershipType

string (OwnershipType)

Enum: "DIRECTLY" "INDIRECTLY"

shareOwnership

number

llcMembership

number

partnershipAllocation

number

other

number

firstName

string

middleName

string

lastName

string

isUsPerson

boolean

dateOfBirth

string <date-time>

ssn

string

taxCountry

string (CountryCode)

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

taxState

string

phoneNumber

string

email

string

object

Non Us Person Tax Id

	object (DefaultDocumentArgsDto)
countryOfIssuance	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
passportNumber	string

associatedPartyId

string

object (IdentificationDocumentArgsDto)

documentType required	string (IdentificationDocumentType) Enum: "DRIVER_LICENSE" "PASSPORT" "STATE_ID" "PERMANENT_RESIDENT_CARD"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (ProofOfAddressDocumentArgsDto)

documentType required	string (AddressProofDocumentType) Enum: "UTILITY_BILL" "BANK_STATEMENTS" "TAX_RETURN_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Array of objects (DefaultDocumentArgsDto)

Array

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

customerId

required

string

beneficialOwnerId

string

isIndividualOwner

boolean

object (CompanyAssociationAddress)

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

occupation

string

occupationTitle

string

object (CompanyAssociationAddress)

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
street1 required	string
street2	string
city required	string
state required	string
postalCode required	string

isAddressProofSkipped

boolean

isHaveRelationWithPEP

boolean

countryOfPEP

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

relationWithPEP

string

hasCertification

boolean

certificationDetails

string

Responses

Request samples

Payload

Content type

application/json

{"associatedPartyTypes": ["FORMATION_OFFICER"
],
"profile": {"ownershipType": "DIRECTLY",
"shareOwnership": 0,
"llcMembership": 0,
"partnershipAllocation": 0,
"other": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isUsPerson": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"taxCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string",
"nonUsTaxIdInfo": {"passportId": {"documentType": "string",
"uploadedDocumentId": "string"
},
"countryOfIssuance": "AD",
"passportNumber": "string"
}
},
"associatedPartyId": "string",
"identificationDoc": {"documentType": "DRIVER_LICENSE",
"uploadedDocumentId": "string"
},
"proofOfAddressDoc": {"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string"
},
"businessEntityFormationAndGoverningDocs": [{"documentType": "string",
"uploadedDocumentId": "string"
}
],
"customerId": "string",
"beneficialOwnerId": "string",
"isIndividualOwner": true,
"primaryResidentialAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"occupation": "string",
"occupationTitle": "string",
"primaryBusinessAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isAddressProofSkipped": true,
"isHaveRelationWithPEP": true,
"countryOfPEP": "AD",
"relationWithPEP": "string",
"hasCertification": true,
"certificationDetails": "string"
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"associatedPartyTypes": ["FORMATION_OFFICER"
],
"profile": {"ownershipType": "DIRECTLY",
"shareOwnership": 0,
"llcMembership": 0,
"partnershipAllocation": 0,
"other": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isUsPerson": true,
"dateOfBirth": "2019-08-24T14:15:22Z",
"ssn": "string",
"nonUsTaxIdInfo": {"passportNumber": "string",
"countryOfIssuance": "AD",
"passportId": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
},
"taxCountry": "AD",
"taxState": "string",
"phoneNumber": "string",
"email": "string"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"identificationDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"businessEntityFormationAndGoverningDocs": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"companyAssociationId": "string",
"customerId": "string",
"beneficialOwnerId": "string",
"isIndividualOwner": true,
"primaryResidentialAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"occupation": "string",
"occupationTitle": "string",
"primaryBusinessAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"isAddressProofSkipped": true,
"isHaveRelationWithPEP": true,
"countryOfPEP": "AD",
"relationWithPEP": "string",
"hasCertification": true,
"certificationDetails": "string",
"metadata": { },
"pendingActions": { },
"id": { }
}

Company Due Diligence

Create a Company Due Diligence

Authorizations:

bearer

Request Body schema: application/json
required

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (UpdateBusinessInformationDto)

annualRevenueType

required

string (RevenueType)

Enum: "TRUST" "OTHER"

annualProfitType

required

string (RevenueType)

Enum: "TRUST" "OTHER"

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

industryType

required

string

Type of industry the business operates in.

naicsCode

required

string

North American Industry Classification System (NAICS) code.

naicsDescription

required

string

Description of the NAICS code.

natureOfBusiness

required

string

Nature of the business operations.

businessProductsAndServices

required

string

Primary products and services offered by the business.

numberOfBranches

required

number >= 0

Number of branches the business operates.

required

Array of objects (LocationOfBranches)

Locations of business branches.

Array

country

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

The country code where the branch is located, using ISO 3166-1 alpha-2 country codes.

state

required

string

The state or province within the country where the branch is located. This must be an ISO recognized state code relative to the specified country.

noOfEmployees

required

number >= 0

Number of employees working for the business.

required

Array of objects (PrimaryTradeAreas)

Primary trade areas where the business operates.

Array

country

required

string (CountryCode)

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

expectedVolume

number [ 0 .. 100 ]

The expected volume of trade within this area as a percentage of total trade, ranging from 0 to 100%.

Array of objects (CounterParties)

Array

country

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

The country where the counter-party is registered or operates, represented by ISO 3166-1 alpha-2 country codes.

name

required

string

The name of the counter-party involved in a transaction or business relationship.

Array of objects (CounterParties)

Major suppliers to the business.

Array

country

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

The country where the counter-party is registered or operates, represented by ISO 3166-1 alpha-2 country codes.

name

required

string

The name of the counter-party involved in a transaction or business relationship.

nameOfPrimaryBank

required

string

Name of the primary bank with which the business is associated.

totalOutstandingDebt

required

number >= 0

Total outstanding debt of the business.

totalAvailableCash

required

number >= 0

Total available cash of the business.

annualRevenue

required

number >= 0

Annual revenue of the business.

annualRevenueCashPercentage

required

number [ 0 .. 100 ]

Percentage of annual revenue in cash.

annualProfit

required

number >= 0

Annual profit of the business.

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Array of objects (DirectorInformationDto)

Array

isDirectorManager	boolean
positionTitle required	string
countryCode required	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
state required	string
	object (IdDocumentArgsDto)
fullLegalName required	string The full legal name of the ownership entity.
address required	string The registered address of the ownership entity.
shareOwnership	number [ 0 .. 100 ] Percentage of shares owned by the entity.
llcMembership	number [ 0 .. 100 ] Percentage of LLC membership held by the entity.
partnershipAllocation	number [ 0 .. 100 ] Percentage of partnership allocation to the entity.
otherInterestOwnership	number [ 0 .. 100 ] Percentage of other interest ownerships held by the entity.
identificationString required	string Identification string or number for the entity, such as a registration number.

Array of objects (ManagementInformationDto)

Array

positionTitle required	string
countryCode required	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
state required	string
	object (IdDocumentArgsDto)
fullLegalName required	string The full legal name of the ownership entity.
address required	string The registered address of the ownership entity.
shareOwnership	number [ 0 .. 100 ] Percentage of shares owned by the entity.
llcMembership	number [ 0 .. 100 ] Percentage of LLC membership held by the entity.
partnershipAllocation	number [ 0 .. 100 ] Percentage of partnership allocation to the entity.
otherInterestOwnership	number [ 0 .. 100 ] Percentage of other interest ownerships held by the entity.
identificationString required	string Identification string or number for the entity, such as a registration number.

object (BankingDocDocumentArgsDto)

documentType required	string (BankingResolutionDocType) Enum: "CERTIFICATE_OF_INCUMBENCY" "CORPORATE_RESOLUTION" "BOARD_RESOLUTION" "OTHER"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Array of objects (IndividualBeneficialOwnerDto)

Array

relationToBusiness	Array of strings (OwnerRelationshipToBusiness) Items Enum: "DIRECTOR" "MANAGER" "OTHER" "NONE"
	object (IdDocumentArgsDto)
fullLegalName required	string The full legal name of the ownership entity.
address required	string The registered address of the ownership entity.
shareOwnership	number [ 0 .. 100 ] Percentage of shares owned by the entity.
llcMembership	number [ 0 .. 100 ] Percentage of LLC membership held by the entity.
partnershipAllocation	number [ 0 .. 100 ] Percentage of partnership allocation to the entity.
otherInterestOwnership	number [ 0 .. 100 ] Percentage of other interest ownerships held by the entity.
identificationString required	string Identification string or number for the entity, such as a registration number.

Array of objects (LegalEntityBeneficialOwnerDto)

Array

	object (LegalEntityIdDocumentArgsDto)
fullLegalName required	string The full legal name of the ownership entity.
address required	string The registered address of the ownership entity.
shareOwnership	number [ 0 .. 100 ] Percentage of shares owned by the entity.
llcMembership	number [ 0 .. 100 ] Percentage of LLC membership held by the entity.
partnershipAllocation	number [ 0 .. 100 ] Percentage of partnership allocation to the entity.
otherInterestOwnership	number [ 0 .. 100 ] Percentage of other interest ownerships held by the entity.
identificationString required	string Identification string or number for the entity, such as a registration number.

Array of objects (DefaultDocumentArgsDto)

Array

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Array of objects (DefaultDocumentArgsDto)

Array

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (ProofOfAddressArgsDto)

documentType required	string (AddressProofDocumentType) Enum: "UTILITY_BILL" "BANK_STATEMENTS" "TAX_RETURN_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

customerId

required

string

Unique identifier for the customer.

required

object

Pre-assessment of company due diligence requirements.

constrainedEngagementInfo

required

Array of arrays (CompanyDueDiligenceConstrainedEngagementCategories)

Items Enum: "ABUSE_OF_OTHER_USERS" "ABUSIVE_ACTIVITY" "FRAUD" "INTELLECTUAL_PROPERTY_INFRINGEMENT" "POLICIES_AND_DOCUMENTATION" "UNLAWFUL_ACTIVITY" "UNLAWFUL_GAMBLING" "CIRCUMVENTION" "COMPETING_PRODUCT" "INTERFERENCE" "REVERSE_ENGINEER" "SUBLICENSE" "ADULT_CONTENT_AND_SERVICES" "CROWDFUNDING_OR_CROWDSOURCING" "DEALERS_OF_HIGH_VALUE_PRECIOUS_GOODS_ANTIQUES_AUCTION_HOUSES_ESTATE_AGENTS" "ILLEGAL_WILDLIFE_TRADE" "INVESTMENT_CLUBS" "MARIJUANA_RELATED_BUSINESSES" "POOLED_ASSET_VEHICLES" "PROFESSIONAL_SERVICE_PROVIDERS" "RELIGIOUS_SPIRITUAL_ORGANIZATIONS" "UNLICENSED_FINANCIAL_SERVICE_PROVIDER" "COUNTERFEIT_OR_UNAUTHORIZED_GOODS" "DRUGS_AND_DRUG_PARAPHERNALIA" "INTELLECTUAL_PROPERTY_OR_PROPRIETARY_RIGHTS_INFRINGEMENT" "MULTI_LEVEL_MARKETING" "PSEUDO_PHARMACEUTICALS" "SUBSTANCES_DESIGNED_TO_MIMIC_ILLEGAL_DRUGS" "UNFAIR_PREDATORY_OR_DECEPTIVE_PRACTICES" "BEARER_SHARE_COMPANIES_NOMINEE_DIRECTORS_OFFICERS_AND_OR_SHAREHOLDERS" "ALCOHOLIC_BEVERAGES" "BULK_SHIPMENTS_OF_CURRENCY" "CHEMICALS" "DEALERS_IN_PRECIOUS_METALS_STONES_OR_JEWELS" "DIETARY_SUPPLEMENTS" "EMBASSY_FOREIGN_CONSULATE_AND_FOREIGN_MISSION_ACCOUNTS" "FINANCIAL_INSTITUTIONS_NESTED_ACCOUNTS" "FINANCIAL_INSTITUTIONS_PAYABLE_THROUGH_ACCOUNT" "FOREIGN_GOVERNMENTS" "FOREIGN_OFFSHORE_SHELL_COMPANIES_BEARER_SHARES" "MEDICAL_DEVICES_AND_MEDICATIONS" "SHELL_BANKS" "TOBACCOS_GOODS" "REGULATED_PRODUCTS_AND_SERVICES" "UNLAWFUL_OR_ILLEGAL_ACTIVITIES" "VIOLENCE_RELATED_ACTIVITIES" "MONEY_SERVICES_BUSINESS" "AGENT_OF_AN_MSB" "OTHER_FINANCIAL_SERVICES" "PAYDAY_LENDERS" "VIRTUAL_ASSET_SERVICE_PROVIDER" "GAMES_OF_SKILL" "ARMS_DEALERS" "ARMS_DEALERS_MILITARY" "CAISNO_GAMBLING_FOREIGN" "DEPOSIT_BROKERS" "ENVIRONMENTAL_CRIMES" "INDEPENDENT_AUTOMATED_TELLER_MACHINE_OWNERS_OR_OPERATORS_INCLUDING_CRYPTO_ATMS" "INDEPENDENT_SALES_ORGANISATION" "NOMINEE_INCORPORATION_SERVICES_FIRMS_INTRODUCING_ENTITIES" "NON_GOVERNMENT_ORGANISATIONS_CHARITIES_AND_NONPROFIT_ORGANISATIONS" "NUCLEAR_ATOMIC_POWER" "OPERATORS_OF_CREDIT_CARD_SYSTEMS" "PAWNBROKERS" "PEP_FOREIGN" "PHONE_CARD_DISTRIBUTORS" "PRIVATE_MILITARY_FIRMS" "PROFESSIONAL_FOOTBALL_SOCCER_CLUBS" "SPECIALIZED_FINANCIAL_INTERMEDIARIES_PROFESSIONALS_FOREIGN" "STATE_OWNED_ENTITIES_FOREIGN" "TRAVELMARKETING" "TRAVEL_AND_TOUR_COMPANIES" "CASINO_GAMBLING_DOMESTIC" "INVESTMENT_AND_CREDIT_SERVICES" "STOCKS_AND_OTHER_SECURITY_INTERESTS" "THIRD_PARTY_PAYMENT_PROCESSORS_TPPS_PAYMENT_SERVICE_PROVIDERS_PSPS"

Information related to customer engagement that might be constrained due to regulatory or policy reasons.

object

Financial conditions of the customer.

netEstimatedAssets required	string (AllowNetEstimatedAssetRanges) Enum: "UPTO_10K" "TEN_TO_100K" "ONEHUNDREDK_TO_1M" "ONE_TO_10M" "TEN_TO_50M" "FIFTY_TO_250M" "MORE_THAN_250M"
required	Array of strings or NetAssetsSourceType (string) non-empty Array of NetAssetsSourceType or can have at most a unknown string value
Array One of string

isLegalOrIndividualOwnersExist

boolean

Flag to indicate if legal or individual owners exist.

isGoodStanding

boolean

Indicates whether the company is in good standing legally and financially.

Responses

Request samples

Payload

Content type

application/json

{"beneficialOwnersCertificateDoc": {"documentType": "string",
"uploadedDocumentId": "string"
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"currentBankStatementsDoc": {"documentType": "string",
"uploadedDocumentId": "string"
},
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"ownershipStructureChart": {"documentType": "string",
"uploadedDocumentId": "string"
},
"businessManagementOrgChart": {"documentType": "string",
"uploadedDocumentId": "string"
},
"boardDirectors": [{"isDirectorManager": true,
"positionTitle": "string",
"countryCode": "AD",
"state": "string",
"idDocument": {"documentType": "US_TIN",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C"
}
],
"managementExecutives": [{"positionTitle": "string",
"countryCode": "AD",
"state": "string",
"idDocument": {"documentType": "US_TIN",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C"
}
],
"bankingResolutionDoc": {"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR"
],
"idDocument": {"documentType": "US_TIN",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C"
}
],
"proofOfExistence": [{"documentType": "string",
"uploadedDocumentId": "string"
}
],
"goodStandingCertificateDoc": {"documentType": "string",
"uploadedDocumentId": "string"
},
"governingDoc": [{"documentType": "string",
"uploadedDocumentId": "string"
}
],
"irsEinLetterDoc": {"documentType": "string",
"uploadedDocumentId": "string"
},
"proofOfAddressDoc": {"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string"
},
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"isLegalOrIndividualOwnersExist": true,
"isGoodStanding": true
}

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Find all Company Due Diligences

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find a specific Company Due Diligence by ID

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Business Information for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

annualRevenueType

required

string (RevenueType)

Enum: "TRUST" "OTHER"

annualProfitType

required

string (RevenueType)

Enum: "TRUST" "OTHER"

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

industryType

required

string

Type of industry the business operates in.

naicsCode

required

string

North American Industry Classification System (NAICS) code.

naicsDescription

required

string

Description of the NAICS code.

natureOfBusiness

required

string

Nature of the business operations.

businessProductsAndServices

required

string

Primary products and services offered by the business.

numberOfBranches

required

number >= 0

Number of branches the business operates.

required

Array of objects (LocationOfBranches)

Locations of business branches.

Array

country

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

The country code where the branch is located, using ISO 3166-1 alpha-2 country codes.

state

required

string

The state or province within the country where the branch is located. This must be an ISO recognized state code relative to the specified country.

noOfEmployees

required

number >= 0

Number of employees working for the business.

required

Array of objects (PrimaryTradeAreas)

Primary trade areas where the business operates.

Array

country

required

string (CountryCode)

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

expectedVolume

number [ 0 .. 100 ]

The expected volume of trade within this area as a percentage of total trade, ranging from 0 to 100%.

Array of objects (CounterParties)

Array

country

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

The country where the counter-party is registered or operates, represented by ISO 3166-1 alpha-2 country codes.

name

required

string

The name of the counter-party involved in a transaction or business relationship.

Array of objects (CounterParties)

Major suppliers to the business.

Array

country

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

The country where the counter-party is registered or operates, represented by ISO 3166-1 alpha-2 country codes.

name

required

string

The name of the counter-party involved in a transaction or business relationship.

nameOfPrimaryBank

required

string

Name of the primary bank with which the business is associated.

totalOutstandingDebt

required

number >= 0

Total outstanding debt of the business.

totalAvailableCash

required

number >= 0

Total available cash of the business.

annualRevenue

required

number >= 0

Annual revenue of the business.

annualRevenueCashPercentage

required

number [ 0 .. 100 ]

Percentage of annual revenue in cash.

annualProfit

required

number >= 0

Annual profit of the business.

Responses

Request samples

Payload

Content type

application/json

{"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"currentBankStatementsDoc": {"documentType": "string",
"uploadedDocumentId": "string"
},
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Company Pre Assessment for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

constrainedEngagementInfo

required

Array of arrays (CompanyDueDiligenceConstrainedEngagementCategories)

Items Enum: "ABUSE_OF_OTHER_USERS" "ABUSIVE_ACTIVITY" "FRAUD" "INTELLECTUAL_PROPERTY_INFRINGEMENT" "POLICIES_AND_DOCUMENTATION" "UNLAWFUL_ACTIVITY" "UNLAWFUL_GAMBLING" "CIRCUMVENTION" "COMPETING_PRODUCT" "INTERFERENCE" "REVERSE_ENGINEER" "SUBLICENSE" "ADULT_CONTENT_AND_SERVICES" "CROWDFUNDING_OR_CROWDSOURCING" "DEALERS_OF_HIGH_VALUE_PRECIOUS_GOODS_ANTIQUES_AUCTION_HOUSES_ESTATE_AGENTS" "ILLEGAL_WILDLIFE_TRADE" "INVESTMENT_CLUBS" "MARIJUANA_RELATED_BUSINESSES" "POOLED_ASSET_VEHICLES" "PROFESSIONAL_SERVICE_PROVIDERS" "RELIGIOUS_SPIRITUAL_ORGANIZATIONS" "UNLICENSED_FINANCIAL_SERVICE_PROVIDER" "COUNTERFEIT_OR_UNAUTHORIZED_GOODS" "DRUGS_AND_DRUG_PARAPHERNALIA" "INTELLECTUAL_PROPERTY_OR_PROPRIETARY_RIGHTS_INFRINGEMENT" "MULTI_LEVEL_MARKETING" "PSEUDO_PHARMACEUTICALS" "SUBSTANCES_DESIGNED_TO_MIMIC_ILLEGAL_DRUGS" "UNFAIR_PREDATORY_OR_DECEPTIVE_PRACTICES" "BEARER_SHARE_COMPANIES_NOMINEE_DIRECTORS_OFFICERS_AND_OR_SHAREHOLDERS" "ALCOHOLIC_BEVERAGES" "BULK_SHIPMENTS_OF_CURRENCY" "CHEMICALS" "DEALERS_IN_PRECIOUS_METALS_STONES_OR_JEWELS" "DIETARY_SUPPLEMENTS" "EMBASSY_FOREIGN_CONSULATE_AND_FOREIGN_MISSION_ACCOUNTS" "FINANCIAL_INSTITUTIONS_NESTED_ACCOUNTS" "FINANCIAL_INSTITUTIONS_PAYABLE_THROUGH_ACCOUNT" "FOREIGN_GOVERNMENTS" "FOREIGN_OFFSHORE_SHELL_COMPANIES_BEARER_SHARES" "MEDICAL_DEVICES_AND_MEDICATIONS" "SHELL_BANKS" "TOBACCOS_GOODS" "REGULATED_PRODUCTS_AND_SERVICES" "UNLAWFUL_OR_ILLEGAL_ACTIVITIES" "VIOLENCE_RELATED_ACTIVITIES" "MONEY_SERVICES_BUSINESS" "AGENT_OF_AN_MSB" "OTHER_FINANCIAL_SERVICES" "PAYDAY_LENDERS" "VIRTUAL_ASSET_SERVICE_PROVIDER" "GAMES_OF_SKILL" "ARMS_DEALERS" "ARMS_DEALERS_MILITARY" "CAISNO_GAMBLING_FOREIGN" "DEPOSIT_BROKERS" "ENVIRONMENTAL_CRIMES" "INDEPENDENT_AUTOMATED_TELLER_MACHINE_OWNERS_OR_OPERATORS_INCLUDING_CRYPTO_ATMS" "INDEPENDENT_SALES_ORGANISATION" "NOMINEE_INCORPORATION_SERVICES_FIRMS_INTRODUCING_ENTITIES" "NON_GOVERNMENT_ORGANISATIONS_CHARITIES_AND_NONPROFIT_ORGANISATIONS" "NUCLEAR_ATOMIC_POWER" "OPERATORS_OF_CREDIT_CARD_SYSTEMS" "PAWNBROKERS" "PEP_FOREIGN" "PHONE_CARD_DISTRIBUTORS" "PRIVATE_MILITARY_FIRMS" "PROFESSIONAL_FOOTBALL_SOCCER_CLUBS" "SPECIALIZED_FINANCIAL_INTERMEDIARIES_PROFESSIONALS_FOREIGN" "STATE_OWNED_ENTITIES_FOREIGN" "TRAVELMARKETING" "TRAVEL_AND_TOUR_COMPANIES" "CASINO_GAMBLING_DOMESTIC" "INVESTMENT_AND_CREDIT_SERVICES" "STOCKS_AND_OTHER_SECURITY_INTERESTS" "THIRD_PARTY_PAYMENT_PROCESSORS_TPPS_PAYMENT_SERVICE_PROVIDERS_PSPS"

Information related to customer engagement that might be constrained due to regulatory or policy reasons.

Responses

Request samples

Payload

Content type

application/json

{"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Customer Financial Condition for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

netEstimatedAssets required	string (AllowNetEstimatedAssetRanges) Enum: "UPTO_10K" "TEN_TO_100K" "ONEHUNDREDK_TO_1M" "ONE_TO_10M" "TEN_TO_50M" "FIFTY_TO_250M" "MORE_THAN_250M"
required	Array of strings or NetAssetsSourceType (string) non-empty Array of NetAssetsSourceType or can have at most a unknown string value
Array One of string

Responses

Request samples

Payload

Content type

application/json

{"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Ownership Structure Chart for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Responses

Request samples

Payload

Content type

application/json

{"ownershipStructureChart": {"documentType": "string",
"uploadedDocumentId": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Business Management Organization Chart for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Responses

Request samples

Payload

Content type

application/json

{"businessManagementOrgChart": {"documentType": "string",
"uploadedDocumentId": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Executive Information for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

executiveType

required

string (BusinessExecutiveType)

Enum: "INDIVIDUAL_BENEFICIAL_OWNER" "LEGAL_ENTITY_BENEFICIAL_OWNER" "MANAGEMENT_EXECUTIVE" "BOARD_DIRECTOR"

object

Board director information.

isDirectorManager

boolean

positionTitle

required

string

countryCode

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

state

required

string

object (IdDocumentArgsDto)

documentType required	string (IdDocumentType) Enum: "US_TIN" "PASSPORT" "RESIDENT_ALIEN_ID" "OTHER_GOVERNMENT_ISSUED_ID" "LEGAL_ENTITY_ID_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

fullLegalName

required

string

The full legal name of the ownership entity.

address

required

string

The registered address of the ownership entity.

shareOwnership

number [ 0 .. 100 ]

Percentage of shares owned by the entity.

llcMembership

number [ 0 .. 100 ]

Percentage of LLC membership held by the entity.

partnershipAllocation

number [ 0 .. 100 ]

Percentage of partnership allocation to the entity.

otherInterestOwnership

number [ 0 .. 100 ]

Percentage of other interest ownerships held by the entity.

identificationString

required

string

Identification string or number for the entity, such as a registration number.

id

string

object

Management executive information.

positionTitle

required

string

countryCode

required

string

Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

state

required

string

object (IdDocumentArgsDto)

documentType required	string (IdDocumentType) Enum: "US_TIN" "PASSPORT" "RESIDENT_ALIEN_ID" "OTHER_GOVERNMENT_ISSUED_ID" "LEGAL_ENTITY_ID_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

fullLegalName

required

string

The full legal name of the ownership entity.

address

required

string

The registered address of the ownership entity.

shareOwnership

number [ 0 .. 100 ]

Percentage of shares owned by the entity.

llcMembership

number [ 0 .. 100 ]

Percentage of LLC membership held by the entity.

partnershipAllocation

number [ 0 .. 100 ]

Percentage of partnership allocation to the entity.

otherInterestOwnership

number [ 0 .. 100 ]

Percentage of other interest ownerships held by the entity.

identificationString

required

string

Identification string or number for the entity, such as a registration number.

id

string

object

Individual beneficial owner information.

relationToBusiness

Array of strings (OwnerRelationshipToBusiness)

Items Enum: "DIRECTOR" "MANAGER" "OTHER" "NONE"

object (IdDocumentArgsDto)

documentType required	string (IdDocumentType) Enum: "US_TIN" "PASSPORT" "RESIDENT_ALIEN_ID" "OTHER_GOVERNMENT_ISSUED_ID" "LEGAL_ENTITY_ID_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

fullLegalName

required

string

The full legal name of the ownership entity.

address

required

string

The registered address of the ownership entity.

shareOwnership

number [ 0 .. 100 ]

Percentage of shares owned by the entity.

llcMembership

number [ 0 .. 100 ]

Percentage of LLC membership held by the entity.

partnershipAllocation

number [ 0 .. 100 ]

Percentage of partnership allocation to the entity.

otherInterestOwnership

number [ 0 .. 100 ]

Percentage of other interest ownerships held by the entity.

identificationString

required

string

Identification string or number for the entity, such as a registration number.

id

string

object

Legal entity beneficial owner information.

object (LegalEntityIdDocumentArgsDto)

documentType required	string (LegalEntityIdDocumentType) Value: "LEGAL_ENTITY_ID_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

fullLegalName

required

string

The full legal name of the ownership entity.

address

required

string

The registered address of the ownership entity.

shareOwnership

number [ 0 .. 100 ]

Percentage of shares owned by the entity.

llcMembership

number [ 0 .. 100 ]

Percentage of LLC membership held by the entity.

partnershipAllocation

number [ 0 .. 100 ]

Percentage of partnership allocation to the entity.

otherInterestOwnership

number [ 0 .. 100 ]

Percentage of other interest ownerships held by the entity.

identificationString

required

string

Identification string or number for the entity, such as a registration number.

id

string

Responses

Request samples

Payload

Content type

application/json

{"executiveType": "INDIVIDUAL_BENEFICIAL_OWNER",
"boardDirector": {"isDirectorManager": true,
"positionTitle": "string",
"countryCode": "AD",
"state": "string",
"idDocument": {"documentType": "US_TIN",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
},
"managementExecutive": {"positionTitle": "string",
"countryCode": "AD",
"state": "string",
"idDocument": {"documentType": "US_TIN",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
},
"individualBeneficialOwner": {"relationToBusiness": ["DIRECTOR"
],
"idDocument": {"documentType": "US_TIN",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
},
"legalEntityBeneficialOwner": {"idDocument": {"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Banking Resolution for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

object (BankingDocDocumentArgsDto)

documentType required	string (BankingResolutionDocType) Enum: "CERTIFICATE_OF_INCUMBENCY" "CORPORATE_RESOLUTION" "BOARD_RESOLUTION" "OTHER"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Responses

Request samples

Payload

Content type

application/json

{"bankingResolutionDoc": {"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Beneficial Owners Certificate for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Responses

Request samples

Payload

Content type

application/json

{"beneficialOwnersCertificateDoc": {"documentType": "string",
"uploadedDocumentId": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Business Formation and Govering Documents for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

Array of objects (DefaultDocumentArgsDto)

Array

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

isGoodStanding

boolean

Indicates whether the company is in good standing legally and financially.

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Array of objects (DefaultDocumentArgsDto)

Array

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

object (DefaultDocumentArgsDto)

documentType required	string
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Responses

Request samples

Payload

Content type

application/json

{"proofOfExistence": [{"documentType": "string",
"uploadedDocumentId": "string"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"documentType": "string",
"uploadedDocumentId": "string"
},
"governingDoc": [{"documentType": "string",
"uploadedDocumentId": "string"
}
],
"irsEinLetterDoc": {"documentType": "string",
"uploadedDocumentId": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update the Proof of Address for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

object (ProofOfAddressArgsDto)

documentType required	string (AddressProofDocumentType) Enum: "UTILITY_BILL" "BANK_STATEMENTS" "TAX_RETURN_DOCUMENT"
uploadedDocumentId required	string Unique identifier of the uploaded document, generated as a UUID.

Responses

Request samples

Payload

Content type

application/json

{"proofOfAddressDoc": {"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string"
}
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Update No Owner Exists for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Delete the Executive by Type for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

executiveTypes

required

Array of strings (BusinessExecutiveType)

Items Enum: "INDIVIDUAL_BENEFICIAL_OWNER" "LEGAL_ENTITY_BENEFICIAL_OWNER" "MANAGEMENT_EXECUTIVE" "BOARD_DIRECTOR"

Responses

Request samples

Payload

Content type

application/json

{"executiveTypes": ["INDIVIDUAL_BENEFICIAL_OWNER"
]
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Delete the Executive by ID for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Request Body schema: application/json
required

executiveType required	string (BusinessExecutiveType) Enum: "INDIVIDUAL_BENEFICIAL_OWNER" "LEGAL_ENTITY_BENEFICIAL_OWNER" "MANAGEMENT_EXECUTIVE" "BOARD_DIRECTOR"
executiveId required	string

Responses

Request samples

Payload

Content type

application/json

{"executiveType": "INDIVIDUAL_BENEFICIAL_OWNER",
"executiveId": "string"
}

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Check Access for a specific Company Due Diligence

Authorizations:

bearer

path Parameters

companyDueDiligenceId required	string
customerId required	string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"pendingActions": ["BANKING_RESOLUTION_REQUIRED",
"BENEFICIAL_OWNER_CERTIFICATE_REQUIRED"
],
"customerId": "string",
"companyPreAssessment": {"constrainedEngagementInfo": ["ABUSE_OF_OTHER_USERS",
"ABUSIVE_ACTIVITY"
]
},
"businessInformation": {"annualRevenueType": "TRUST",
"annualProfitType": "TRUST",
"industryType": "Manufacturing",
"naicsCode": "336340",
"naicsDescription": "Motor Vehicle Brake System Manufacturing",
"natureOfBusiness": "Producer of automotive brakes",
"businessProductsAndServices": "Brake pads, Brake discs",
"numberOfBranches": 5,
"locationOfBranches": [{"country": "US",
"state": "CA"
}
],
"noOfEmployees": 200,
"primaryTradeAreas": [{"country": "AD",
"expectedVolume": 25
}
],
"majorCustomers": [{"country": "US",
"name": "Doe Industries"
}
],
"majorSuppliers": [{"country": "US",
"name": "Doe Industries"
}
],
"nameOfPrimaryBank": "Bank of America",
"totalOutstandingDebt": 200,
"totalAvailableCash": 200,
"currentBankStatementsDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"annualRevenue": 2000,
"annualRevenueCashPercentage": 25,
"annualProfit": 2000
},
"companyCustomerFinancialCondition": {"netEstimatedAssets": "UPTO_10K",
"netAssetsSource": ["string"
]
},
"ownershipStructureChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"isLegalOrIndividualOwnersExist": true,
"beneficialOwnersCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"individualBeneficialOwners": [{"relationToBusiness": ["DIRECTOR",
"MANAGER"
],
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"legalEntityBeneficialOwners": [{"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "LEGAL_ENTITY_ID_DOCUMENT",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"businessManagementOrgChart": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"boardDirectors": [{"countryCode": "US",
"isDirectorManager": true,
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"managementExecutives": [{"countryCode": "US",
"positionTitle": "Chief Financial Officer",
"state": "CA",
"idDocument": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "US_TIN",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"fullLegalName": "John Doe Enterprises LLC",
"address": "1234 Elm Street, Springfield, USA",
"shareOwnership": 75,
"llcMembership": 35,
"partnershipAllocation": 50,
"otherInterestOwnership": 10,
"identificationString": "AB123456C",
"id": "string"
}
],
"bankingResolutionDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "CERTIFICATE_OF_INCUMBENCY",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfExistence": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"isGoodStanding": true,
"goodStandingCertificateDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"governingDoc": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
}
],
"irsEinLetterDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"proofOfAddressDoc": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "UTILITY_BILL",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg"
},
"metadata": { },
"id": { }
}

Get the Pending Actions

Authorizations:

bearer

path Parameters

companyDueDiligenceId

required

string

Responses

Response samples

200

Content type

application/json

{"pendingActions": ["string"
]
}

Deposit

Find a specific pull Deposit Details

Authorizations:

bearer

path Parameters

depositId

required

string

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)

Responses

Response samples

200

Content type

application/json

{"depositType": "PUSH",
"depositStatus": "REQUESTED",
"id": "string",
"customerId": "string",
"createdAt": "2024-04-26T12:00:00Z",
"amount": 1000,
"reference": "Payment for services",
"destinationAccountAssetId": "string",
"destinationAssetsTypeId": "string",
"sourceCounterpartyId": "string",
"sourceAssetTypeId": "string"
}

Create a Push Deposit

Authorizations:

bearer

Request Body schema: application/json
required

accountAssetId

required

string

The account asset ID.

Responses

Request samples

Payload

Content type

application/json

{"accountAssetId": "string"
}

Response samples

201

Content type

application/json

{"depositStatus": "REQUESTED",
"createdAt": "string",
"depositType": "PUSH",
"depositInstructions": [{"instructionType": "CRYPTO",
"address": "string",
"blockchain": "string",
"network": "string",
"assetTypeId": "string",
"accountHolderName": "string",
"accountNumber": "string",
"accountRoutingNumber": "string",
"accountHolderAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"swiftBic": "string",
"institutionName": "string",
"institutionAddress": {"countryCode": "AD",
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"postalCode": "string"
},
"memo": "string",
"description": "string"
}
],
"destinationAccountAssetId": "string",
"destinationAssetsTypeId": "string",
"customerId": "string"
}

Create a Pull Deposit

Authorizations:

bearer

Request Body schema: application/json
required

sourceCounterpartyId required	string The ID of the source counterparty.
amount required	number >= 1 The amount of the deposit.
reference	string The reference associated with the deposit.
accountAssetId required	string The account asset ID.

Responses

Request samples

Payload

Content type

application/json

{"sourceCounterpartyId": "string",
"amount": 1000,
"reference": "Payment for services",
"accountAssetId": "string"
}

Response samples

201

Content type

application/json

{"depositType": "PUSH",
"depositStatus": "REQUESTED",
"id": "string",
"customerId": "string",
"createdAt": "2024-04-26T12:00:00Z",
"amount": 1000,
"reference": "Payment for services",
"destinationAccountAssetId": "string",
"destinationAssetsTypeId": "string",
"sourceCounterpartyId": "string",
"sourceAssetTypeId": "string"
}

Find all pull Deposits

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"depositDocuments": [{"depositType": "PUSH",
"depositStatus": "REQUESTED",
"id": "string",
"customerId": "string",
"createdAt": "2024-04-26T12:00:00Z",
"amount": 1000,
"reference": "Payment for services",
"destinationAccountAssetId": "string",
"destinationAssetsTypeId": "string",
"sourceCounterpartyId": "string",
"sourceAssetTypeId": "string"
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Create an Accept Pull Deposit

Authorizations:

bearer

path Parameters

depositId

required

string

Responses

Response samples

201

Content type

application/json

{"depositType": "PUSH",
"depositStatus": "REQUESTED",
"id": "string",
"customerId": "string",
"createdAt": "2024-04-26T12:00:00Z",
"amount": 1000,
"reference": "Payment for services",
"destinationAccountAssetId": "string",
"destinationAssetsTypeId": "string",
"sourceCounterpartyId": "string",
"sourceAssetTypeId": "string"
}

Counterparty

Create a Counter Party

Authorizations:

bearer

Request Body schema: application/json
required

counterpartyType

required

string (CounterpartyType)

Enum: "FIAT_US" "FIAT_CA" "FIAT_EU" "FIAT_GB" "FIAT_MX" "FIAT_BS" "FIAT_CN" "FIAT_SG" "FIAT_HK" "FIAT_PA" "FIAT_MY" "FIAT_JP" "FIAT_AE" "FIAT_BR" "FIAT_CH" "FIAT_SA" "FIAT_GT" "FIAT_QA" "FIAT_BH" "FIAT_CR" "FIAT_TR" "FIAT_GL" "FIAT_PL" "FIAT_US_LINKED" "BASIC"

supportedRails

required

Array of arrays (SupportedRails)

Items Enum: "ACH" "FEDWIRE" "SWIFT"

Supported transaction rails for the counterparty.

profileType

required

string (ProfileType)

Enum: "INDIVIDUAL" "CORPORATION"

required

IndividualAccountHolderProfile (object) or CorporationAccountHolderProfile (object)

Profile information for the counterparty, detailing personal and business- related data

One of

relationshipToCustomer

string (RelationshipType)

Enum: "SPOUSE" "EX_SPOUSE" "CHILDREN" "PARENT" "SIBLING" "RELATIVE" "SELF" "FRIEND" "BUSINESS_PARTNER" "CUSTOMER" "EMPLOYEE" "BRANCH_OFFICE" "SUBSIDIARY_COMPANY" "HOLDING_COMPANY" "SUPPLIER" "CREDITOR" "DEBTOR" "FRANCHISEE" "NOT_RELATED"

firstName

required

string

First name of the counterparty.

lastName

required

string

Last name of the counterparty.

dateOfBirth

string <date-time>

date of birth of the counterparty, formatted as YYYY-MM-DD.

email

string

Email address of the counterparty.

telephoneNumber

string

Telephone number of the counterparty in E.164 format.

taxReferenceNumber

string

Tax reference number of the counterparty.

required

object

Address of the counterparty.

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
state	string
street1 required	string
street2	string
city required	string
postalCode required	string

customerId

required

string

Customer ID associated with the counterparty.

creatorUserId

string

User ID of the creator.

description

required

string

Description or additional details about the counterparty.

required

object

Bank account information associated with the counterparty.

assetTypeId

required

string (AssetTypeId)

Enum: "ETHEREUM_GOERLI_ETH" "ETHEREUM_GOERLI_USDC" "SOLANA_DEVNET_SOL" "BITCOIN_TESTNET_BTC" "FIAT_TESTNET_USD" "FIAT_MAINNET_USD" "FIAT_TESTNET_EUR" "FIAT_MAINNET_EUR" "FIAT_TESTNET_CAD" "FIAT_MAINNET_CAD" "FIAT_TESTNET_GBP" "FIAT_MAINNET_GBP" "FIAT_TESTNET_INR" "FIAT_MAINNET_INR" "FIAT_TESTNET_MXN" "FIAT_MAINNET_MXN" "FIAT_TESTNET_BSD" "FIAT_MAINNET_BSD" "FIAT_TESTNET_CNY" "FIAT_MAINNET_CNY" "FIAT_TESTNET_SGD" "FIAT_MAINNET_SGD" "FIAT_TESTNET_HKD" "FIAT_MAINNET_HKD" "FIAT_TESTNET_PAB" "FIAT_MAINNET_PAB" "FIAT_TESTNET_MYR" "FIAT_MAINNET_MYR" "FIAT_TESTNET_JPY" "FIAT_MAINNET_JPY" "FIAT_TESTNET_AED" "FIAT_MAINNET_AED" "FIAT_TESTNET_BRL" "FIAT_MAINNET_BRL" "FIAT_TESTNET_CHF" "FIAT_MAINNET_CHF" "FIAT_TESTNET_SAR" "FIAT_MAINNET_SAR" "FIAT_TESTNET_GTQ" "FIAT_MAINNET_GTQ" "FIAT_TESTNET_QAR" "FIAT_MAINNET_QAR" "FIAT_TESTNET_BHD" "FIAT_MAINNET_BHD" "FIAT_TESTNET_CRC" "FIAT_MAINNET_CRC" "FIAT_TESTNET_TRL" "FIAT_MAINNET_TRL" "FIAT_TESTNET_DKK" "FIAT_MAINNET_DKK" "FIAT_TESTNET_PLN" "FIAT_MAINNET_PLN"

bankAccountType

required

string (BankAccountType)

Enum: "CHECKING" "SAVING"

accountNumber

required

string

The unique number identifying the account within the financial institution.

routingNumber

required

string = 9 characters

The routing number for the account.

swiftBic

string/^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/

SWIFT/BIC code for international banking.

institutionName

string

name of the financial institution where the account is held.

object

Address of the financial institution where the account is held.

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
state	string
street1 required	string
street2	string
city required	string
postalCode required	string

object

Information about intermediary institutions involved with the counterparty.

intermediaryType

required

string (IntermediaryType)

Enum: "FIAT_PA" "FIAT_MY" "FIAT_JP" "FIAT_SG" "FIAT_HK" "FIAT_GB" "FIAT_CN" "FIAT_EU" "FIAT_CA" "FIAT_IN" "FIAT_US"

institutionName

required

string

Name of the intermediary institution.

object

Address of the institution.

countryCode required	string (CountryCode) Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RW" "SA" "SB" "SC" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "ST" "SV" "SX" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
state	string
street1 required	string
street2	string
city required	string
postalCode required	string

swiftBic

string/^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/

SWIFT/BIC code for international banking.

routingNumber

string

The routing number for the account.

Responses

Request samples

Payload

Content type

application/json

{"counterpartyType": "FIAT_US",
"supportedRails": "ACH",
"profileType": "INDIVIDUAL",
"profile": {"relationshipToCustomer": "SPOUSE",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-04-15",
"email": "john.doe@example.com",
"telephoneNumber": "+1234567890",
"taxReferenceNumber": "123-45-6789",
"address": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
}
},
"customerId": "string",
"creatorUserId": "string",
"description": "Counterparty for high-value transactions, primarily deals in automotive imports.",
"accountInformation": {"assetTypeId": "ETHEREUM_GOERLI_ETH",
"bankAccountType": "CHECKING",
"accountNumber": "123456789012",
"routingNumber": "021000021",
"swiftBic": "string",
"institutionName": "Chase Bank",
"institutionAddress": "Chase Bank"
},
"intermediaryInformation": {"intermediaryType": "FIAT_PA",
"institutionName": "Bank of America",
"institutionAddress": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
},
"swiftBic": "string",
"routingNumber": "021000021"
}
}

Response samples

201

Content type

application/json

{"counterpartyType": "FIAT_US",
"supportedRails": "ACH",
"profileType": "INDIVIDUAL",
"profile": {"relationshipToCustomer": "SPOUSE",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-04-15",
"email": "john.doe@example.com",
"telephoneNumber": "+1234567890",
"taxReferenceNumber": "123-45-6789",
"address": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
}
},
"status": "ACTIVE",
"customerId": "string",
"creatorUserId": "string",
"description": "Counterparty for high-value transactions, primarily deals in automotive imports.",
"isLinked": false,
"isKYCDone": false,
"accountInformation": {"assetTypeId": "ETHEREUM_GOERLI_ETH",
"bankAccountType": "CHECKING",
"accountNumber": "123456789012",
"routingNumber": "021000021",
"swiftBic": "string",
"institutionName": "Chase Bank",
"institutionAddress": "Chase Bank"
},
"intermediaryInformation": {"intermediaryType": "FIAT_PA",
"institutionName": "Bank of America",
"institutionAddress": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
},
"swiftBic": "string",
"routingNumber": "021000021"
},
"bankingPartnerError": "string",
"metadata": { },
"id": { }
}

Find all Counterparties

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"counterparties": [{"counterpartyType": "FIAT_US",
"supportedRails": "ACH",
"profileType": "INDIVIDUAL",
"profile": {"relationshipToCustomer": "SPOUSE",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-04-15",
"email": "john.doe@example.com",
"telephoneNumber": "+1234567890",
"taxReferenceNumber": "123-45-6789",
"address": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
}
},
"status": "ACTIVE",
"customerId": "string",
"creatorUserId": "string",
"description": "Counterparty for high-value transactions, primarily deals in automotive imports.",
"isLinked": false,
"isKYCDone": false,
"accountInformation": {"assetTypeId": "ETHEREUM_GOERLI_ETH",
"bankAccountType": "CHECKING",
"accountNumber": "123456789012",
"routingNumber": "021000021",
"swiftBic": "string",
"institutionName": "Chase Bank",
"institutionAddress": "Chase Bank"
},
"intermediaryInformation": {"intermediaryType": "FIAT_PA",
"institutionName": "Bank of America",
"institutionAddress": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
},
"swiftBic": "string",
"routingNumber": "021000021"
},
"bankingPartnerError": "string",
"metadata": { },
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find a specific Counter Party

Authorizations:

bearer

path Parameters

counterpartyId

required

string

Responses

Response samples

200

Content type

application/json

{"counterpartyType": "FIAT_US",
"supportedRails": "ACH",
"profileType": "INDIVIDUAL",
"profile": {"relationshipToCustomer": "SPOUSE",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-04-15",
"email": "john.doe@example.com",
"telephoneNumber": "+1234567890",
"taxReferenceNumber": "123-45-6789",
"address": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
}
},
"status": "ACTIVE",
"customerId": "string",
"creatorUserId": "string",
"description": "Counterparty for high-value transactions, primarily deals in automotive imports.",
"isLinked": false,
"isKYCDone": false,
"accountInformation": {"assetTypeId": "ETHEREUM_GOERLI_ETH",
"bankAccountType": "CHECKING",
"accountNumber": "123456789012",
"routingNumber": "021000021",
"swiftBic": "string",
"institutionName": "Chase Bank",
"institutionAddress": "Chase Bank"
},
"intermediaryInformation": {"intermediaryType": "FIAT_PA",
"institutionName": "Bank of America",
"institutionAddress": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
},
"swiftBic": "string",
"routingNumber": "021000021"
},
"bankingPartnerError": "string",
"metadata": { },
"id": { }
}

Find Counter Party Linking Details by Counterparty id

Authorizations:

bearer

path Parameters

counterpartyId

required

string

Request Body schema: application/json
required

isMobileWebview required	boolean Indicates whether the linking should be done through a mobile webview.
redirectUrl required	string The URL to which users will be redirected after a successful account linking process. This should be a valid URL conforming to standard URL formats.

Responses

Request samples

Payload

Content type

application/json

{"isMobileWebview": true,
"redirectUrl": "https://www.example.com/redirect-success"
}

Response samples

201

Content type

application/json

{"linkingProvider": "string",
"isMobileWebview": true,
"uiMessageWebviewUrlScheme": "com.example.app://link",
"mxWidgetUrl": "https://link.mx.com/?key=public_key&token=link_token"
}

Find all Linkable Accounts

Authorizations:

bearer

path Parameters

counterpartyId

required

string

Request Body schema: application/json
required

memberGuid required	string The unique identifier for the member whose accounts are to be linked.
bankAccountType required	string Enum: "CHECKING" "SAVING"

Responses

Request samples

Payload

Content type

application/json

{"memberGuid": "string",
"bankAccountType": "CHECKING"
}

Response samples

201

Content type

application/json

{"counterpartyId": "string",
"linkingProvider": "string",
"availableAccount": [{"accountLinkId": "string",
"accountName": "Checking Account - 1234",
"accountNumber": "string"
}
],
"memberGuid": "string"
}

Link the countryparty with account

Authorizations:

bearer

path Parameters

counterpartyId

required

string

Request Body schema: application/json
required

accountLinkId

required

string

Account ID

Responses

Request samples

Payload

Content type

application/json

{"accountLinkId": "string"
}

Response samples

201

Content type

application/json

{"counterpartyType": "FIAT_US",
"supportedRails": "ACH",
"profileType": "INDIVIDUAL",
"profile": {"relationshipToCustomer": "SPOUSE",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-04-15",
"email": "john.doe@example.com",
"telephoneNumber": "+1234567890",
"taxReferenceNumber": "123-45-6789",
"address": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
}
},
"status": "ACTIVE",
"customerId": "string",
"creatorUserId": "string",
"description": "Counterparty for high-value transactions, primarily deals in automotive imports.",
"isLinked": false,
"isKYCDone": false,
"accountInformation": {"assetTypeId": "ETHEREUM_GOERLI_ETH",
"bankAccountType": "CHECKING",
"accountNumber": "123456789012",
"routingNumber": "021000021",
"swiftBic": "string",
"institutionName": "Chase Bank",
"institutionAddress": "Chase Bank"
},
"intermediaryInformation": {"intermediaryType": "FIAT_PA",
"institutionName": "Bank of America",
"institutionAddress": {"countryCode": "AD",
"state": "string",
"street1": "string",
"street2": "string",
"city": "string",
"postalCode": "string"
},
"swiftBic": "string",
"routingNumber": "021000021"
},
"bankingPartnerError": "string",
"metadata": { },
"id": { }
}

Withdrawal

Create a Withdrawal

Authorizations:

bearer

Request Body schema: application/json
required

withdrawalRail required	string (WithdrawalRail) Value: "ACH"
withdrawalPurpose required	string (WithdrawalPurpose) Enum: "PERSONAL_ACCOUNT" "FAMILY" "INSURANCE" "INVESTMENT" "REAL_ESTATE" "TUITION" "MEDICAL" "TRAVEL" "TRADE_TRANSACTIONS" "UTILITY" "TAX" "LOAN" "BILLS" "PAYROLL" "TELECOM" "INTELLECTUAL_PROPERTY" "OTHER_BUSINESS_SERVICES" "CHARITABLE_DONATIONS" "MORTGAGE" "EXPENSES_REIMBURSEMENT" "PROFESSIONAL_SERVICES" "MARKETING" "RENTAL_PROPERTY" "OTHER"
description	string
accountAssetId required	string Asset account identifier from which the withdrawal is made.
destinationCounterpartyId required	string
amount required	number >= 1
memo	string

Responses

Request samples

Payload

Content type

application/json

{"withdrawalRail": "ACH",
"withdrawalPurpose": "PERSONAL_ACCOUNT",
"description": "string",
"accountAssetId": "asset-account-uuid-1234",
"destinationCounterpartyId": "string",
"amount": 1,
"memo": "string"
}

Response samples

201

Content type

application/json

{"withdrawalRail": "ACH",
"withdrawalStatus": "REQUESTED",
"withdrawalPurpose": "PERSONAL_ACCOUNT",
"id": "string",
"transactionId": "string",
"description": "string",
"accountAssetId": "asset-account-uuid-1234",
"amount": 1,
"destinationCounterpartyId": "string",
"memo": "string"
}

Find all Withdrawals

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"withdrawalDocuments": [{"withdrawalRail": "ACH",
"withdrawalStatus": "REQUESTED",
"withdrawalPurpose": "PERSONAL_ACCOUNT",
"id": "string",
"transactionId": "string",
"description": "string",
"accountAssetId": "asset-account-uuid-1234",
"amount": 1,
"destinationCounterpartyId": "string",
"memo": "string"
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find a specific Withdrawal by Withdrawal id

Authorizations:

bearer

path Parameters

withdrawalId

required

string

Responses

Response samples

200

Content type

application/json

{"withdrawalRail": "ACH",
"withdrawalStatus": "REQUESTED",
"withdrawalPurpose": "PERSONAL_ACCOUNT",
"id": "string",
"transactionId": "string",
"description": "string",
"accountAssetId": "asset-account-uuid-1234",
"amount": 1,
"destinationCounterpartyId": "string",
"memo": "string"
}

Transaction

Find a specific Transaction

Authorizations:

bearer

path Parameters

transactionId

required

string

Responses

Response samples

200

Content type

application/json

{ }

Find all Transactions

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"transactionDocuments": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"transactionType": "FIAT_TRANSFER_IN",
"transactionStatus": "AUTHORIZED",
"categoryType": "ADJUSTMENT",
"rail": "ACH",
"id": "string",
"value": 2500.75,
"accountAssetId": "string",
"categoryId": "string",
"description": "Monthly rent payment",
"railMemo": "Final installment for invoice #1234",
"railReference": "string",
"counterparty": { },
"transactionDate": "2023-01-15T14:30:00.000Z",
"transactionPostDate": "2023-01-16T00:00:00.000Z",
"originatorAccountNo": "XXXXXX1234",
"originatorRoutingNo": "111000025",
"originatorType": "Business",
"originatorName": "John Doe Inc."
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

KYC Document Checks

Create a KYC Document Check

Authorizations:

bearer

Request Body schema: application/json
required

documentType required	string (KycDocumentTypeOptions) Enum: "DRIVER_LICENSE" "PASSPORT" "STATE_ID" "PERMANENT_RESIDENT_CARD" "UTILITY_BILL" "BANK_STATEMENTS" "TAX_RETURN_DOCUMENT" "USA_IRS_FORM" "NON_USA_IRS_FORM"
category required	string (KycDocumentCategory) Enum: "ID_DOCUMENT" "TAX_INFO_DOCUMENT" "ADDRESS_PROOF"
uploadedDocumentId	string Unique identifier of the uploaded document, generated as a UUID.
customerId required	string

Responses

Request samples

Payload

Content type

application/json

{"documentType": "DRIVER_LICENSE",
"category": "ID_DOCUMENT",
"uploadedDocumentId": "string",
"customerId": "string"
}

Response samples

201

Content type

application/json

{"kycDocumentCheck": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"category": "ID_DOCUMENT",
"customerId": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg",
"id": { }
},
"success": true
}

Find all KYC Document Checks

Authorizations:

bearer

query Parameters

	object (FilterDto)
	object (FilterDto)
	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"kycDocumentChecks": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"category": "ID_DOCUMENT",
"customerId": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg",
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Find a specific KYC Document Check

Authorizations:

bearer

path Parameters

kycDocumentId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"documentType": "DRIVER_LICENSE",
"category": "ID_DOCUMENT",
"customerId": "string",
"uploadedDocumentId": "string",
"frontSideUrl": "http://example.com/documents/front-side.jpg",
"backSideUrl": "http://example.com/documents/back-side.jpg",
"id": { }
}

Partner Accounts

Create a Partner Account

Authorizations:

bearer

Request Body schema: application/json
required

customerId

required

string

The ID of the customer associated with the partner account.

required

object

Information about the total anticipated transactions for the partner account.

usdValueOfFiat required	string (USDValueOfFiatRange) Enum: "UPTO_10K" "TEN_TO_100K" "ONEHUNDREDK_TO_1M" "ONE_TO_10M" "TEN_TO_50M" "FIFTY_TO_250M" "MORE_THAN_250M"
inflowMonthlyTransactionCount required	string (MonthlyTransactionCountRange) Enum: "UPTO_5" "FIVE_TO_10" "TEN_TO_25" "MORE_THAN_25"
inflowMonthlyTransactionAmount required	string (MonthlyTransactionAmountRange) Enum: "UPTO_1K" "ONE_TO_100K" "ONEHUNDREDK_TO_1M" "MILLION_TO_5M" "MORE_THAN_5M"
outflowMonthlyTransactionCount required	string (MonthlyTransactionCountRange) Enum: "UPTO_5" "FIVE_TO_10" "TEN_TO_25" "MORE_THAN_25"
outflowMonthlyTransactionAmount required	string (MonthlyTransactionAmountRange) Enum: "UPTO_1K" "ONE_TO_100K" "ONEHUNDREDK_TO_1M" "MILLION_TO_5M" "MORE_THAN_5M"

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"totalAnticipatedTransactionInfo": {"usdValueOfFiat": "UPTO_10K",
"inflowMonthlyTransactionCount": "UPTO_5",
"inflowMonthlyTransactionAmount": "UPTO_1K",
"outflowMonthlyTransactionCount": "UPTO_5",
"outflowMonthlyTransactionAmount": "UPTO_1K"
}
}

Response samples

201

Content type

application/json

{"pendingActions": ["TOTAL_ANTICIPATED_TRANSACTION_INFO_REQUIRED"
],
"customerId": "string",
"totalAnticipatedTransactionInfo": {"usdValueOfFiat": "UPTO_10K",
"inflowMonthlyTransactionCount": "UPTO_5",
"inflowMonthlyTransactionAmount": "UPTO_1K",
"outflowMonthlyTransactionCount": "UPTO_5",
"outflowMonthlyTransactionAmount": "UPTO_1K"
},
"id": { }
}

Fetch all Partner Accounts

Authorizations:

bearer

query Parameters

	object (FilterDto)
cursor	string
skip	number
limit	number

Responses

Response samples

200

Content type

application/json

{"partnerAccounts": [{"pendingActions": ["TOTAL_ANTICIPATED_TRANSACTION_INFO_REQUIRED"
],
"customerId": "string",
"totalAnticipatedTransactionInfo": {"usdValueOfFiat": "UPTO_10K",
"inflowMonthlyTransactionCount": "UPTO_5",
"inflowMonthlyTransactionAmount": "UPTO_1K",
"outflowMonthlyTransactionCount": "UPTO_5",
"outflowMonthlyTransactionAmount": "UPTO_1K"
},
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Fetch a Partner Account By ID

Authorizations:

bearer

path Parameters

partnerAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"pendingActions": ["TOTAL_ANTICIPATED_TRANSACTION_INFO_REQUIRED"
],
"customerId": "string",
"totalAnticipatedTransactionInfo": {"usdValueOfFiat": "UPTO_10K",
"inflowMonthlyTransactionCount": "UPTO_5",
"inflowMonthlyTransactionAmount": "UPTO_1K",
"outflowMonthlyTransactionCount": "UPTO_5",
"outflowMonthlyTransactionAmount": "UPTO_1K"
},
"id": { }
}

Update a Partner Account

Authorizations:

bearer

path Parameters

partnerAccountId

required

string

Request Body schema: application/json
required

object

Information about the total anticipated transactions for the partner account.

usdValueOfFiat required	string (USDValueOfFiatRange) Enum: "UPTO_10K" "TEN_TO_100K" "ONEHUNDREDK_TO_1M" "ONE_TO_10M" "TEN_TO_50M" "FIFTY_TO_250M" "MORE_THAN_250M"
inflowMonthlyTransactionCount required	string (MonthlyTransactionCountRange) Enum: "UPTO_5" "FIVE_TO_10" "TEN_TO_25" "MORE_THAN_25"
inflowMonthlyTransactionAmount required	string (MonthlyTransactionAmountRange) Enum: "UPTO_1K" "ONE_TO_100K" "ONEHUNDREDK_TO_1M" "MILLION_TO_5M" "MORE_THAN_5M"
outflowMonthlyTransactionCount required	string (MonthlyTransactionCountRange) Enum: "UPTO_5" "FIVE_TO_10" "TEN_TO_25" "MORE_THAN_25"
outflowMonthlyTransactionAmount required	string (MonthlyTransactionAmountRange) Enum: "UPTO_1K" "ONE_TO_100K" "ONEHUNDREDK_TO_1M" "MILLION_TO_5M" "MORE_THAN_5M"

Responses

Request samples

Payload

Content type

application/json

{"totalAnticipatedTransactionInfo": {"usdValueOfFiat": "UPTO_10K",
"inflowMonthlyTransactionCount": "UPTO_5",
"inflowMonthlyTransactionAmount": "UPTO_1K",
"outflowMonthlyTransactionCount": "UPTO_5",
"outflowMonthlyTransactionAmount": "UPTO_1K"
}
}

Response samples

200

Content type

application/json

{"pendingActions": ["TOTAL_ANTICIPATED_TRANSACTION_INFO_REQUIRED"
],
"customerId": "string",
"totalAnticipatedTransactionInfo": {"usdValueOfFiat": "UPTO_10K",
"inflowMonthlyTransactionCount": "UPTO_5",
"inflowMonthlyTransactionAmount": "UPTO_1K",
"outflowMonthlyTransactionCount": "UPTO_5",
"outflowMonthlyTransactionAmount": "UPTO_1K"
},
"id": { }
}

Fetch a Partner Account Assets

Authorizations:

bearer

path Parameters

partnerAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"accountAssets": [{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "UNDER_REVIEW",
"productType": "CLIENT",
"assetTypeId": "string",
"productId": "string",
"customerId": "string",
"currentBalance": "100000",
"availableBalance": "95000",
"parentAccountId": "string",
"id": { }
}
],
"nextCursor": "string",
"hasMore": true,
"totalCount": 150
}

Fetch a Partner Account Asset By ID

Authorizations:

bearer

path Parameters

partnerAccountId required	string
assetId required	string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "UNDER_REVIEW",
"productType": "CLIENT",
"assetTypeId": "string",
"productId": "string",
"customerId": "string",
"currentBalance": "100000",
"availableBalance": "95000",
"parentAccountId": "string",
"id": { }
}

Submit account application

Authorizations:

bearer

path Parameters

partnerAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "INCOMPLETE",
"accountType": "OPPORTUNITY",
"customerId": "string",
"bankingApplicationId": "string",
"accountApplicationErrors": { },
"defaultAccountAssetId": "string",
"accountId": "string",
"pendingActions": {"customerProfile": ["PERSONAL_INFORMATION_REQUIRED"
],
"partnerAccount": ["TOTAL_ANTICIPATED_TRANSACTION_INFO_REQUIRED"
],
"companyDueDiligence": ["BUSINESS_GENERAL_INFO_REQUIRED"
],
"companyAssociatedParties": { },
"individualDueDiligence": ["OCCUPATION_INFORMATION_REQUIRED"
],
"opportunityAccount": ["ANTICIPATED_INVESTMENT_ACTIVITIES_INFO_REQUIRED"
],
"standardAccount": ["PURPOSE_OF_ACCOUNT"
]
},
"id": { }
}

Account application status

Authorizations:

bearer

path Parameters

partnerAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "INCOMPLETE",
"accountType": "OPPORTUNITY",
"customerId": "string",
"bankingApplicationId": "string",
"accountApplicationErrors": { },
"defaultAccountAssetId": "string",
"accountId": "string",
"pendingActions": {"customerProfile": ["PERSONAL_INFORMATION_REQUIRED"
],
"partnerAccount": ["TOTAL_ANTICIPATED_TRANSACTION_INFO_REQUIRED"
],
"companyDueDiligence": ["BUSINESS_GENERAL_INFO_REQUIRED"
],
"companyAssociatedParties": { },
"individualDueDiligence": ["OCCUPATION_INFORMATION_REQUIRED"
],
"opportunityAccount": ["ANTICIPATED_INVESTMENT_ACTIVITIES_INFO_REQUIRED"
],
"standardAccount": ["PURPOSE_OF_ACCOUNT"
]
},
"id": { }
}

Get the Pending Actions

Authorizations:

bearer

path Parameters

partnerAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"pendingActions": ["string"
]
}

Subscription

Create a Subscription

Authorizations:

bearer

Request Body schema: application/json
required

events required	Array of arrays (SubscriptionType) Items Enum: "BANKING_APPLICATION" "BANKING_CUSTOMER" "BANKING_TRANSACTION" "BANKING_COUNTERPARTY" "BANKING_ACCOUNT_ASSET" "" The events for the subscription, can be an array of SubscriptionType or "" for all events
callbackUrl required	string The callback URL for the subscription.

Responses

Request samples

Payload

Content type

application/json

{"events": ["BANKING_APPLICATION"
],
"callbackUrl": "string"
}

Response samples

201

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"events": ["BANKING_ACCOUNT_ASSET",
"BANKING_APPLICATION"
],
"status": "ENABLED",
"callbackUrl": "string",
"signatureVerficationKey": "string",
"id": { }
}

Get a Subscription

Authorizations:

bearer

Responses

Response samples

200

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"events": ["BANKING_ACCOUNT_ASSET",
"BANKING_APPLICATION"
],
"status": "ENABLED",
"callbackUrl": "string",
"signatureVerficationKey": "string",
"id": { }
}
]

Delete a Subscription

Authorizations:

bearer

path Parameters

subscriptionId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"events": ["BANKING_ACCOUNT_ASSET",
"BANKING_APPLICATION"
],
"status": "ENABLED",
"callbackUrl": "string",
"signatureVerficationKey": "string",
"id": { }
}

Regenerate Subscription Secret

Authorizations:

bearer

path Parameters

subscriptionId

required

string

Responses

Response samples

200

Content type

application/json

{"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"events": ["BANKING_ACCOUNT_ASSET",
"BANKING_APPLICATION"
],
"status": "ENABLED",
"callbackUrl": "string",
"signatureVerficationKey": "string",
"id": { }
}

Auth

Login into your Account

Request Body schema: application/json
required

username required	string The username for authentication.
password required	string The password for authentication.

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

201

Content type

application/json

{"accessToken": "string"
}

Change Account password

Authorizations:

bearer

Request Body schema: application/json
required

newPassword required	string The new password to set. It must meet the following password policy: - At least one lowercase letter (a-z). - At least one uppercase letter (A-Z). - At least one digit (0-9). - At least one special character from the set @$!%*?. - Minimum length: 12, Maximum length: 64.
oldPassword required	string The old password for verification.

Responses

Request samples

Payload

Content type

application/json

{"newPassword": "string",
"oldPassword": "string"
}

Response samples

201

Content type

application/json

{"success": true,
"message": "string"
}

PAF Core Banking Management System (1.2.1)

Utils API

Get states by country code

path Parameters

Responses

Response samples

Get cities by country code and state

path Parameters

Responses

Response samples

Upload Documents

Upload a Document

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Response samples

Find all Uploaded Documents

Authorizations:

query Parameters

Responses

Response samples

Find a specific Uploaded Document

Authorizations:

path Parameters

Responses

Response samples

Customers

Create a Customer

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Find all Customers

Authorizations:

query Parameters

Responses

Response samples

Find the Resource Relationships for Customers

Authorizations:

query Parameters

Responses

Response samples

Find the Resource Relationship for a Customer

Authorizations:

path Parameters

Responses

Response samples

Find a specific Customer by ID

Authorizations:

path Parameters

Responses

Response samples

Update a specific Customer

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch Onboarding Agreement for customer by customer id

Authorizations:

path Parameters

Responses

Response samples

Sign Onboarding Agreement for customer by customer id

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get the Pending Actions

Authorizations:

path Parameters

Responses

Response samples

Company Association

Create a Company Association

Authorizations:

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required