logo

Boarding

Submit Application

SecurityJWT
Request
Request Body schema:
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitBusinessInformationDto)
required
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitLocationAddressDto)

Location Address. Refers to a physical place or establishment where a business conducts its commercial activities, accepts payments, and provides goods or services to customers

isLegalAddressTheSame
required
boolean

Is legal address the same

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitAddressDto)
required
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitOwnerDto)
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitAuthorizedSignerDto)
isPrimaryContactTheSame
boolean

Is Primary Contact the same as the Owner 1?

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.Submit.SubmitPrimaryContactDto)
achProcessor
string (RiseCRM.ExternalApi.HttpClient.Dto.v1.Enum.ACHProcessorDto)

Aurora Partner that securely manages and facilitates electronic financial ACH transactions between buyers and sellers, ensuring the efficient transfer of funds and compliance with security standards

achq

Value Description
achq

ACHQ, Inc. is one of the fastest growing electronic payment ach processing companies in the world. The company is a venture-funded entity located in the Tampa Bay Florida area that offers payment-processing services to businesses in all 50 U.S. states. https://achq.com/about/

object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SubmitAchProcessorDataDto)

ACHQ specific information. Required if achProcessor is set.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/v1/boarding/applications/submit
Request samples
{
  • "businessInformation": {
    },
  • "locationAddress": {
    },
  • "isLegalAddressTheSame": false,
  • "legalAddress": {
    },
  • "owner1": {
    },
  • "owner2": {
    },
  • "owner3": {
    },
  • "owner4": {
    },
  • "authorizedSigner": {
    },
  • "isPrimaryContactTheSame": true,
  • "primaryContact": {
    },
  • "achProcessor": "achq",
  • "achProcessorData": {
    }
}
Response samples
application/json
{
  • "urlForSigning": "string",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "applicationNumber": 0
}

Submit Draft Application

SecurityJWT
Request
path Parameters
applicationId
required
string <uuid>
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/v1/boarding/applications/{applicationId}/submit
Request samples 
Response samples 
application/json
{
  • "urlForSigning": "string",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "applicationNumber": 0
}
Create Draft Application
SecurityJWT 
Request 
Request Body schema: 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressBusinessInformationDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressLocationAddressDto) 
 
isLegalAddressTheSame
boolean
Is legal address the same


 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAddressDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAuthorizedSignerDto) 
 
isPrimaryContactTheSame
boolean
Is Primary Contact the same as the Owner 1?


 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressPrimaryContactDto) 
 
achProcessor
string (RiseCRM.ExternalApi.HttpClient.Dto.v1.Enum.ACHProcessorDto) 
Aurora Partner that securely manages and facilitates electronic financial ACH transactions between buyers and sellers, ensuring the efficient transfer of funds and compliance with security standards


achq


 Value Description
achq
ACHQ, Inc. is one of the fastest growing electronic payment ach processing companies in the world. The company is a venture-funded entity located in the Tampa Bay Florida area that offers payment-processing services to businesses in all 50 U.S. states. https://achq.com/about/


 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAchProcessorDataDto) 
ACHQ specific information. Required if achProcessor is set.


 
Responses 
200
Success


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/v1/boarding/applications/draft
Request samples 
{
  • "businessInformation": {
    },
  • "locationAddress": {
    },
  • "isLegalAddressTheSame": true,
  • "legalAddress": {
    },
  • "owner1": {
    },
  • "owner2": {
    },
  • "owner3": {
    },
  • "owner4": {
    },
  • "authorizedSigner": {
    },
  • "isPrimaryContactTheSame": true,
  • "primaryContact": {
    },
  • "achProcessor": "achq",
  • "achProcessorData": {
    }
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Update Draft Application
SecurityJWT 
Request 
path Parameters
applicationId
required
string <uuid> 
 
Request Body schema: 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressBusinessInformationDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressLocationAddressDto) 
 
isLegalAddressTheSame
boolean
Is legal address the same


 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAddressDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressOwnerDto) 
 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAuthorizedSignerDto) 
 
isPrimaryContactTheSame
boolean
Is Primary Contact the same as the Owner 1?


 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressPrimaryContactDto) 
 
achProcessor
string (RiseCRM.ExternalApi.HttpClient.Dto.v1.Enum.ACHProcessorDto) 
Aurora Partner that securely manages and facilitates electronic financial ACH transactions between buyers and sellers, ensuring the efficient transfer of funds and compliance with security standards


achq


 Value Description
achq
ACHQ, Inc. is one of the fastest growing electronic payment ach processing companies in the world. The company is a venture-funded entity located in the Tampa Bay Florida area that offers payment-processing services to businesses in all 50 U.S. states. https://achq.com/about/


 
object (RiseCRM.ExternalApi.HttpClient.Dto.v1.Applications.SaveInProgress.SaveInProgressAchProcessorDataDto) 
ACHQ specific information. Required if achProcessor is set.


 
Responses 
200
Success


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


put/v1/boarding/applications/{applicationId}/draft
Request samples 
{
  • "businessInformation": {
    },
  • "locationAddress": {
    },
  • "isLegalAddressTheSame": true,
  • "legalAddress": {
    },
  • "owner1": {
    },
  • "owner2": {
    },
  • "owner3": {
    },
  • "owner4": {
    },
  • "authorizedSigner": {
    },
  • "isPrimaryContactTheSame": true,
  • "primaryContact": {
    },
  • "achProcessor": "achq",
  • "achProcessorData": {
    }
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Get Application Information.
Utilize this request to retrieve information about the application by providing the application ID


SecurityJWT 
Request 
path Parameters
applicationId
required
string <uuid> 
 
Responses 
200
Success


401
Unauthorized


403
Forbidden


404
Not Found


get/v1/boarding/applications/{applicationId}
Request samples 
Response samples 
application/json
{
  • "applicationId": null,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "applicationStatus": "unsignedRequestingSign",
  • "mid": "string",
  • "applicationStatusName": "string",
  • "primaryAgent": {
    },
  • "achProcessorData": {
    },
  • "businessInformation": {
    },
  • "locationAddress": {
    },
  • "isLegalAddressTheSame": false,
  • "legalAddress": {
    },
  • "owner1": {
    },
  • "owner2": {
    },
  • "owner3": {
    },
  • "owner4": {
    },
  • "authorizedSigner": {
    },
  • "isPrimaryContactTheSame": true,
  • "primaryContact": {
    },
  • "achProcessor": "achq"
}
Soft delete Application
SecurityJWT 
Request 
path Parameters
applicationId
required
string <uuid> 
 
Responses 
204
No Content


401
Unauthorized


403
Forbidden


409
Conflict


delete/v1/boarding/applications/{applicationId}
Request samples 
Response samples 
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}
Get Applications listing
SecurityJWT 
Request 
query Parameters
pageIndex
integer <int32> 
 Default:  0
Current index of the paging


 
pageSize
integer <int32> 
 Default:  20
Size of one page


 
Responses 
200
Success


401
Unauthorized


get/v1/boarding/applications
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "count": 0
}
Get url for signing
SecurityJWT 
Request 
path Parameters
applicationId
required
string <uuid> 
 
Responses 
200
Success


401
Unauthorized


403
Forbidden


409
Conflict


get/v1/boarding/applications/{applicationId}/url-for-signing
Request samples 
Response samples 
application/json
"string"
➔ Next to BoardingConfigurations