BoardingDocument

Utilize this endpoint for the submission of any supplementary documents that may assist in the underwriting and boarding procedures.

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Request Body schema: multipart/form-data

Type

string (RiseCRM.ExternalApi.HttpClient.Dto.v1.Enum.DocumentTypeDto)

BankLetter

PhotoIdentification

TaxReturn

BankStatement

VoidedCheck

BusinessLicense

UtilityBill

PreviousProcessorStatements

ApplicationUnredacted

OtherUnderwritingDocuments

EquipmentOrderingForm

UnderwritingDocument

AgentContract

SignedScheduleA

ResidualSplitprofileEmail

Other

NailSoft

Enum Value	Description
BankLetter	Bank Letter
PhotoIdentification	Photo Identification
TaxReturn	Tax Return
BankStatement	Bank Statement
VoidedCheck	Voided Check
BusinessLicense	Business License
UtilityBill	Utility Bill
PreviousProcessorStatements	Previous Processor Statements
ApplicationUnredacted	Application Unredacted
OtherUnderwritingDocuments	Other Underwriting Documents
EquipmentOrderingForm	Equipment Ordering Form
UnderwritingDocument	Underwriting Document
AgentContract	Agent Contract
SignedScheduleA	Signed Schedule A
ResidualSplitprofileEmail	Residual Split Profile Email
Other	Other
NailSoft	Nail Soft Set up

Name

string

File

string <binary>

Responses

201

Created

403

Forbidden

404

Not Found

default

Error

post/v1/boarding/applications/{applicationId}/documents

Request samples

curl

Response samples

201
403
404
default

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"extension": "string",
"contentType": "string",
"type": "BankLetter",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdById": "string"
}

Use this endpoint to get list documents related to the merchant onboarding process.

SecurityJWT

Request

path Parameters

applicationId

required

string <uuid>

Responses

200

Success

404

Not Found

get/v1/boarding/applications/{applicationId}/documents

Request samples

curl

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"extension": "string",
"contentType": "string",
"type": "BankLetter",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdById": "string"
}

Use this endpoint to access documents related to the merchant onboarding process.

SecurityJWT

Request

path Parameters

applicationId required	string <uuid>
id required	string <uuid>

Responses

200

Success

404

Not Found

get/v1/boarding/applications/{applicationId}/documents/{id}

Request samples

curl

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"extension": "string",
"contentType": "string",
"type": "BankLetter",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdById": "string"
}

Utilize this endpoint to delete document related to the merchant onboarding process.

SecurityJWT

Request

path Parameters

applicationId required	string <uuid>
id required	string <uuid>

Responses

204

No Content

403

Forbidden

409

Conflict

default

Error

delete/v1/boarding/applications/{applicationId}/documents/{id}

Request samples

curl

Response samples

403
409
default

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Use this endpoint if you need to familiarise yourself with the document’s content.

SecurityJWT

Request

path Parameters

applicationId required	string <uuid>
id required	string <uuid>

Responses

200

Success

404

Not Found

get/v1/boarding/applications/{applicationId}/documents/{id}/content

Request samples

curl

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"extension": "string",
"contentType": "string",
"type": "BankLetter",
"createdAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"createdById": "string"
}