Skip to main content

Agreement

Agreement signing is necessary for the customer to start using the platform. The agreement is a PDF document that needs to be signed by the customer (via API). The agreement is a legal document that outlines the terms and conditions of using the platform. If the agreement is not signed, the customer will not be able to use the platform. A pending status will be added to make sure that the agreement is signed.

Get Agreement​

GET /customers/{customerId}/onboarding-agreement

Sample Response​

base64 url PDF

Any PDF viewer integrated with web can be used to view the agreement. The same base64 encoding of the pdf can be shared as a download button on the UI.

Sign Agreement​

POST /customers/{customerId}/onboarding-agreement

Sample Request​

{
  "partnerAgreementDocId": "e6c8447c-e5f8-425c-b274-549eee02e559" // Optional
}

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": "",
    "companyAssociationId": "",
    "opportunityAccountId": "",
    "standardAccountId": "",
    "partnerAccountId": "",
    "bankingApplicationId": "",
    "counterpartyIds": []
  },
  "pendingActions": [],
  "createdAt": "2024-08-02T11:48:02.416Z",
  "updatedAt": "2024-08-02T12:03:21.881Z",
  "__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 4844760077",
      "faxNumber": "45834753",
      "email": "Enrique76@yahoo.com",
      "website": "abc@q3c.com",
      "socialMedia": [""]
    }
  },
  "id": "84ee11bb-9834-42a8-aac3-89ef026d640e"
}