logo

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
integer <int32> (DocumentTypeDto)

Possible values:

  • 0 - BankLetter: Bank Letter
  • 1 - PhotoIdentification: Photo Identification
  • 2 - TaxReturn: Tax Return
  • 3 - BankStatement: Bank Statement
  • 4 - VoidedCheck: Voided Check
  • 5 - BusinessLicense: Business License
  • 6 - UtilityBill: Utility Bill
  • 7 - PreviousProcessorStatements: Previous Processor Statements
  • 8 - ApplicationUnredacted: Application Unredacted
  • 9 - OtherUnderwritingDocuments: Other Underwriting Documents
  • 10 - EquipmentOrderingForm: Equipment Ordering Form
  • 11 - AgentContract: Agent Contract
  • 12 - SignedScheduleA: Signed Schedule A
  • 13 - ResidualSplitprofileEmail: Residual Split Profile Email
  • 14 - Other: Other
  • 15 - NailSoft: Nail Soft Set up
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
Name
string
File
string <binary>
Responses
201

Created

403

Forbidden

404

Not Found

default

Error

post/v1/boarding/applications/{applicationId}/documents
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "extension": "string",
  • "contentType": "string",
  • "type": 0,
  • "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
OK


404
Not Found


get/v1/boarding/applications/{applicationId}/documents
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "extension": "string",
  • "contentType": "string",
  • "type": 0,
  • "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
OK


404
Not Found


get/v1/boarding/applications/{applicationId}/documents/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "extension": "string",
  • "contentType": "string",
  • "type": 0,
  • "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 
Response samples 
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
OK


404
Not Found


get/v1/boarding/applications/{applicationId}/documents/{id}/content
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "extension": "string",
  • "contentType": "string",
  • "type": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "createdById": "string"
}