Partner Account
First we need to create a partner account by submitting the details, partner account details are required to create a partner account.
Create Partner Account
Sample Request
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"totalAnticipatedTransactionInfo": {
"usdValueOfFiat": "ONEHUNDREDK_TO_1M",
"inflowMonthlyTransactionCount": "TEN_TO_25",
"inflowMonthlyTransactionAmount": "ONE_TO_100K",
"outflowMonthlyTransactionCount": "FIVE_TO_10",
"outflowMonthlyTransactionAmount": "ONEHUNDREDK_TO_1M"
}
}
Sample Response
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"totalAnticipatedTransactionInfo": {
"usdValueOfFiat": "ONEHUNDREDK_TO_1M",
"inflowMonthlyTransactionCount": "TEN_TO_25",
"inflowMonthlyTransactionAmount": "ONE_TO_100K",
"outflowMonthlyTransactionCount": "FIVE_TO_10",
"outflowMonthlyTransactionAmount": "ONEHUNDREDK_TO_1M"
},
"pendingActions": [],
"createdAt": "2024-08-02T12:09:01.343Z",
"updatedAt": "2024-08-02T12:09:01.761Z",
"__v": 0,
"id": "aaebce0e-4f31-447f-9dbc-d633f800f0ef"
}
Once the partner account is created, we can verify the account status by using the below API.
Partner Account Status
/partner-accounts/:partnerAccountId/status
Sample Response
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "READY_FOR_SUBMISSION",
"defaultAccountAssetId": null,
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:09:57.524Z",
"updatedAt": "2024-08-02T12:09:57.524Z",
"__v": 0,
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}
Then we need to submit the partner account application by using the below API. This will submit the partner account for KYC review. Once the partner account is submitted, KYC is passed and customer is approved by the banking partner. we can verify the account status by using the API above.
Submit Partner Account
/partner-accounts/:partnerAccountId/submit
Partner account application status will be changed to UNDER_REVIEW after submitting the application.
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "UNDER_REVIEW",
"defaultAccountAssetId": null,
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:09:57.524Z",
"updatedAt": "2024-08-02T12:10:57.542Z",
"__v": 1,
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}
Partner Account Status (After KYC Approval)
/partner-accounts/:partnerAccountId/status
Sample Response
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "PROCESSING",
"defaultAccountAssetId": "732d8333-0f00-4a6e-80de-095f0c1e7941,
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:10:57.524Z",
"updatedAt": "2024-08-02T12:11:57.542Z",
"__v": 1,
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}
Partner Account Status (In case Changes are required)
/partner-accounts/:partnerAccountId/status
In case the application needs some changes or additional information, the status will be changed to CHANGES_REQUESTED.
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "CHANGES_REQUESTED",
"defaultAccountAssetId": "732d8333-0f00-4a6e-80de-095f0c1e7941",
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:09:57.524Z",
"updatedAt": "2024-08-02T12:37:05.750Z",
"__v": 23,
"bankingApplicationId": "2e204d06-7092-4651-b879-2271cd22b4bf",
"accountApplicationErrors": {
"applicationDocumentErrors": [],
"validationErrors": [
{
"fieldName": "customer.contactDetails.phoneNumber",
"fieldStatus": "CHANGES_REQUESTED",
"description": "'Phone' is not valid"
}
],
"applicationIndividualErrors": [
{
"associatedPartyId": "7ba42b34-6f3f-4fa4-a675-d8efb38f3436",
"individualId": "65090b67-b18c-4b33-aa2a-3d7ada20e292",
"validationErrors": [],
"documentErrors": []
}
],
"applicationErrors": []
},
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}
In this scenario, the application needs to be updated with the required information and resubmitted for approval.
For example, in this scenario, the phone number is not valid and some documents are missing.
So we can update the phone number using the update customer api.
Once the details are updated, we can resubmit the partner account application using the API mentioned previously.
Update Customer API
Sample Request
{
"customerType": "COMPANY",
"profile": {
"contactDetails": {
"email": "Justina.Schulist@yahoo.com",
"faxNumber": "45834753",
"phoneNumber": "+1 9599946975",
"socialMedia": [""],
"website": "abc@q3c.com"
}
}
}
Sample Response
{
"userId": "283dfc7c-cb6c-45fc-ab8a-01c4c539d639",
"customerType": "COMPANY",
"primaryAddress": {
"countryCode": "US",
"street1": "123 Main Street",
"street2": "Suite 101",
"city": "Capital City",
"state": "AL",
"postalCode": "12345"
},
"isRegisteredAndPrimaryAddressSame": false,
"registeredAddress": {
"countryCode": "US",
"street1": "456 Secondary Road",
"street2": "Apt 202",
"city": "Major Town",
"state": "AL",
"postalCode": "67890"
},
"isPostalAndPrimaryAddressSame": false,
"postalAddress": {
"countryCode": "US",
"street1": "789 Tertiary Lane",
"street2": "Room 303",
"city": "Small Village",
"state": "AL",
"postalCode": "10112"
},
"resourceRelationships": {
"individualDueDiligenceId": "",
"companyDueDiligenceId": "66e87a1f-080c-4689-b16a-0db503d0c9a6",
"companyAssociationId": "1f64a05a-8c50-486f-a17e-47473e23277e",
"opportunityAccountId": "",
"standardAccountId": "",
"partnerAccountId": "aaebce0e-4f31-447f-9dbc-d633f800f0ef",
"bankingApplicationId": "2e204d06-7092-4651-b879-2271cd22b4bf",
"counterpartyIds": []
},
"pendingActions": [],
"createdAt": "2024-08-02T11:48:02.416Z",
"updatedAt": "2024-08-02T12:44:16.201Z",
"__v": 0,
"agreementDocuments": {
"agreementDoc": {
"documentType": "ONBOARDING_AGREEMENT",
"uploadedDocumentId": "d0ada754-e2d3-4a19-9017-545698829b2c",
"frontSideUrl": "https://cbms-alpha-docs.s3.us-east-2.amazonaws.com/84ee11bb-9834-42a8-aac3-89ef026d640e/-c3b55bbd-fe96-4f91-9b6d-8eaa330fc762.pdf",
"backSideUrl": null
},
"isSigned": true,
"partnerAgreementDoc": {
"documentType": "PARTNER_ACCOUNT_AGREEMENT",
"uploadedDocumentId": "e6c8447c-e5f8-425c-b274-549eee02e559",
"frontSideUrl": "https://cbms-alpha-docs.s3.us-east-2.amazonaws.com/84ee11bb-9834-42a8-aac3-89ef026d640e/-30c8e9cb-5977-4533-b741-dbba44cb9f6c.pdf",
"backSideUrl": null
}
},
"profile": {
"entityType": "CORPORATION",
"name": "Joanna Rosenbaum DDS",
"alternateName": "Carl Weber",
"isUsPerson": true,
"ein": "437563468",
"stateRegistrationNumber": "250195848",
"tin": "911-71-5354",
"tinIssuingCountry": "US",
"taxCountry": "US",
"taxState": "AL",
"taxClassification": "C_CORPORATION_PRIVATE",
"formationRegionCountry": "US",
"formationRegionState": "AL",
"dateOfFormation": "2023-01-01T00:00:00.000Z",
"contactDetails": {
"phoneNumber": "+1 9599846975",
"faxNumber": "45835753",
"email": "Justina.Schulist@yahoo.com",
"website": "abc@q3c.com",
"socialMedia": [""]
}
},
"id": "84ee11bb-9834-42a8-aac3-89ef026d640e"
}
Partner Account Resubmission
/partner-accounts/:partnerAccountId/submit
Sample Response
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "UNDER_REVIEW",
"defaultAccountAssetId": "732d8333-0f00-4a6e-80de-095f0c1e7941",
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:09:57.524Z",
"updatedAt": "2024-08-02T12:47:21.695Z",
"__v": 25,
"bankingApplicationId": "2e204d06-7092-4651-b879-2271cd22b4bf",
"accountApplicationErrors": {
"applicationDocumentErrors": [],
"validationErrors": [
{
"fieldName": "customer.contactDetails.phoneNumber",
"fieldStatus": "CHANGES_REQUESTED",
"description": "'Phone' is not valid"
}
],
"applicationIndividualErrors": [
{
"associatedPartyId": "7ba42b34-6f3f-4fa4-a675-d8efb38f3436",
"individualId": "65090b67-b18c-4b33-aa2a-3d7ada20e292",
"validationErrors": [],
"documentErrors": []
}
],
"applicationErrors": []
},
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "PROCESSING",
"defaultAccountAssetId": "732d8333-0f00-4a6e-80de-095f0c1e7941",
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:09:57.524Z",
"updatedAt": "2024-08-02T12:53:57.832Z",
"__v": 43,
"bankingApplicationId": "2e204d06-7092-4651-b879-2271cd22b4bf",
"accountApplicationErrors": {
"applicationErrors": null
},
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}
Partner Account Status (Once Approved)
/partner-accounts/:partnerAccountId/status
Sample Response
{
"customerId": "84ee11bb-9834-42a8-aac3-89ef026d640e",
"status": "APPROVED",
"defaultAccountAssetId": "732d8333-0f00-4a6e-80de-095f0c1e7941",
"accountType": "PARTNER",
"pendingActions": {
"customerProfile": [],
"companyDueDiligence": [],
"companyAssociatedParties": [],
"partnerAccount": []
},
"createdAt": "2024-08-02T12:09:57.524Z",
"updatedAt": "2024-08-02T12:56:20.532Z",
"__v": 47,
"bankingApplicationId": "2e204d06-7092-4651-b879-2271cd22b4bf",
"accountApplicationErrors": {
"applicationErrors": null
},
"id": "fc332f48-b821-494e-b602-f872021d25d7"
}