DOMIDOCS API Documentation

2.1 API Keys

To gain access to the DomiDocs API, please contact sales.
Once you’ve completed the signup process and acknowledged our terms, we will provide your organization with access to our Sandbox API with:

• client_id
• secret
• public_key

2.2 API Protocol

2.3 API Hosts

Sandbox – Testing:  sandbox.domidocs.com 

• • Stateful sandbox environment; use credentials to build out and test your integration.
  • The Sandbox environment supports up to 20 account creations and 10 Items to be added into the created accounts.
  • All testing should be done in the Sandbox environment.

Production – Live:  production.domidocs.com 

• • The Production environment supports unlimited account creations and unlimited Items to be added into the created accounts.
  • You will need to request access before you can access our production environment.
  • All activity in the Production environment will be billed.

3.1 Create Customer

Endpoint: create-customer

Example: create-customer Request 

{
   "email": "[email protected]",
   "first_name": "example",
   "last_name": "example",
   "mobile": "1235678901",
   "phone": "12345678901",
   "password": "example1!qQ",
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

Example Response: create-customer Success 

{
   "message": "User created.",
   "user_id": 169,
   "code": 1000
}

{
   "message": "Invalid Parameters.",
   "errors": {
        "file": [
            "The file parameter is missing."
] },
   "code": 1003
}

3.2 Create Property

{
   "name": "vila gara",
   "address": "vila gara",
   "additional_address": "mcdonalds",
   "city": "iasi",
   "state": "Moldova",
   "zip_code": "1234",
   "country": "United States of America",
   "user_id": 169,
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

{
"message": "Property created.",
"property_id": 467,
"code": 1000
}

{
   "message": "Invalid Parameters.",
   "errors": {
        "user_id": [
            "The user id parameter is missing."
] },
   "code": 1003
}

3.3 Upload Document

Endpoint: upload-document

Example: upload-document Request

{
   "file": FILE,
   "property_id": "467",
   "user_id": 169,
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

Example Response: upload-document Success 

{
   "message": "Document uploaded.",
   "document_id": 14450,
   "code": 1000
}

Example Response: upload-document Error 

{
   "message": "Invalid Parameters.",
   "errors": {
        "file": [
            "The file parameter is missing."
] },
   "code": 1003
}

3.4 Update Document

Endpoint: update-document

Example: update-document Request

{
   "file": FILE,
   "document_id": "14450",
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

Example Response: update-document Success 

{
   "message": "Document updated.",
   "document_id": 14450,
   "code": 1000
}

Example Response: update-document Error 

{
   "message": "Invalid Parameters.",
   "errors": {
        "file": [
            "The file parameter is missing."
] },
   "code": 1003
}

3.5 Get All Created Customers

Endpoint: retrieve-all-customers

Example: retrieve-all-customers Request

{
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

Example Response: retrieve-all-customers Success 

{
   "message": "Success.",
   "customers": [
        {
            "first_name": "example",
            "last_name": "example",
            "email": "[email protected]",
            "mobile": "1235678901",
            "phone": "12345678901"
} ],
   "code": 1000
}

Example Response: retrieve-all-customers Error 

{
   "message": "Invalid Parameters.",
   "errors": {
        "file": [
            "The file parameter is missing."
] },
   "code": 1003
}

3.6 Get All Created Properties

Endpoint: retrieve-all-properties

Example: retrieve-all-properties Request

{
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

Example Response: retrieve-all-properties Success 

{
   "message": "Success.",
   "properties": [
        {
            "property_name": "vila gara",
            "address": "vila gara",
            "city": "iasi",
            "state": "Moldova",
            "zip_code": "1234",
            "country": "United States of America",
            "additional_address": "mcdonalds"
} ],
   "code": 1000
}

{
   "message": "Missing Parameters.",
   "code": 1001
}

3.7 Get All Uploaded Documents

Endpoint: retrieve-all-documents

Example: retrieve-all-documents Request

{
   "client_id": 2,
   "secret": "g6sXfpmjfsBAlHJ2B4SOh5VypaOafKWy2X7uqCsW"
}

Example: retrieve-all-documents Success

{
   "message": "Success.",
   "documents": [
        {
            "document_id": "14450",
            "property_id": "467",
            "file_name": "document1.pdf",
            "extension": "pdf",
            "size": 610454,
            "uploaded_by": "[email protected]"
}, 
{
            "document_id": "14451",
            "property_id": "467",
            "file_name": "document2.pdf",
            "extension": "pdf",
            "size": 489299,            
             "uploaded_by": "[email protected]"
        }
],
   "code": 1000
}

Example Response: retrieve-all-documents Error 

{
   "message": "Missing Parameters.",
   "code": 1001
}

7.1 API Account/Profile

The credentials you provide to us, along with other contact information, can be changed from the Profile page:

7.2 API Stats

In addition to pulling stats via the API, on the Admin Portal sidebar you can check the status of your API 1) Customers Created, 2) Properties Created, 3) Documents Uploaded:

7.3 API Call Logs

On the API Call Logs page, you can see all your API calls that you made for all API endpoints.