Skip to main content
Before Nmbr can process a payroll for a company, Nmbr needs information about the company to meet our regulatory obligations, determine processing periods for the company, and surface onboarding flows. This guide walks through how to submit this information to the Nmbr API before their first payroll.

​
Company container

The Company object is an overarching container that represents a single customer. The Company creation endpoint will return an access_token for future scoped interaction with the API. Request 
curl --request POST \
     --url https://sandbox.nmbr.co/services/payroll/companies \
     --header 'Authorization: Bearer <partner_secret>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
         "name": "Bouchard Burger Inc."
     }'
Response 
{
  "id": "01hhcy3fc40cp6yyv500re1041",
  "object": "company",
  "data": {
    "name": "Bouchard Burger Inc.",
    "pay_day_movement_setting": "inherit",
    "created_at": "2023-12-11T17:16:55.000000Z",
    "updated_at": "2023-12-11T17:16:55.000000Z",
    "token": {
      "access_token": "4nWkuMVylVeJMkOiFaPMzbQwdUklsP08sIqkBifve92a05c2",
      "expires_in": 59,
      "expires_at": "2023-12-11T18:16:55.000000Z"
    }
  },
  "links": {
    "self": "https://sandbox.nmbr.co/services/payroll/companies/01hhcy3fc40cp6yyv500re1041"
  }
}

​
Business entities

The first step in company enrollment is the creation of a Business Entity. Business entities represent a single CRA business account and require a specific set of information to meet our regulatory obligations. Required information includes:
  • Business number
  • Business legal name
  • Business registration number (corporate registration or other)
  • Corporate Address / Address on file with the CRA
  • Business primary contact
A Company can contain one or more Business Entities enabling partners to structure their product for a wide range of industries and use cases. Request 
curl --request POST \
     --url https://sandbox.nmbr.co/services/payroll/business_entities \
     --header 'Authorization: Bearer <access_token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
        "business_number": "36774676RP0001",
        "name": "Bobs Burgers (#67667)",
        "legal_name": "8877362 Inc",
        "legal_registration_number": "047738-9"
        "address_line_1": "13 Main Street",
        "address_line_2": null,
        "city": "Toronto",
        "province_code": "ON",
        "country_code": "CA",
        "postal_code": "M1M1M1",
        "contact_name": "Bob",
        "contact_area_code": "416",
        "contact_phone_number": "3748686",
        "contact_extension": null,
    }'

​
Know Your Customer

KYC means “Know Your Customer.” It is a due diligence process financial companies use to verify customer identity and assess and monitor customer risk. KYC ensures a customer is who they say they are. Nmbr provides all the tools you need to help us meet regulatory requirements together.

​
Automatic Checks

When a new business is added to your account, Nmbr will automatically create a Business Entity Verification. This entity contains status information of the businesses approval state. As customer information is entered, Nmbr automatically captures this data to compare against corporate businesses registries, sanction lists, and other AML inquiries. The results of these checks will become available in your Nmbr dashboard, as well as via the /business_entities/{business_entity_id}/verification API endpoint. Request 
curl --request GET \
     --url https://sandbox.nmbr.co/services/payroll/business_entities/{business_entity_id}/verification \
     --header 'Authorization: Bearer <partner_secret>' \
     --header 'accept: application/json' \
Response 
{
  "id": "01hj1djve5zcjv1mrbvp3ps6aq",
  "object": "business_entity_verification",
  "data": {
    "status": "approved",
    "reviewed_at": "2023-12-19T17:45:02.000000Z",
    "created_at": "2023-12-19T16:12:16.000000Z",
    "updated_at": "2023-12-19T17:45:02.000000Z"
  }
}
If the verification status is approved all KYC related warnings will be resolved. If the verification status is failed, information is provided as to why the failure occurred. Based on this information you can then move the business to the manual verification process.

​
Manual Checks

Manual checks are only required when automated checks fail. Automated checks may fail if corporate information can not be validated using public registry data.
In order for us to perform manual KYC verification the customer is required to provide an identification document. Nmbr accepts any of the following types of identification documents for a business:
  • Certificate of incorporation/registration
  • Memorandum/articles of incorporation/association/registration
  • Directors registry
  • Shareholder registry
  • Trust agreement
  • Proof of address. For example, a utility bill, rent contract or an electricity bill.
  • Certificate of incumbency
  • Statement of information
  • Certificate of good standing
Manual checks can often take 24 hours. The results of this check will become available in your Nmbr dashboard, as well as via the /business_entities/{business_entity_id}/verification API endpoint. If the verification status is approved all KYC related warnings will be resolved. If the verification status is failed, information is provided as to why the failure occurred. Based on this information you can reach out to support@nmbr.co for additional guidance.