Check properties are ready to distribute

Sorts the properties you name into those that can be distributed from and those that cannot, and says why. A property fails when it has no owner information on file or when its owners' shares do not add up to 100%.

POST

https://api.portal.magicdoor.com/company-app/owners/distributions/validate

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

propertyIdsstring[]

The properties to check. Left out, every property is checked.

Response

200 · The properties, split by whether they are ready.

validPropertiesobject[]

Properties that can be distributed from.

needsAttentionPropertiesobject[]

Properties that cannot be distributed from yet.

ownersobject[]

Every owner referenced above, resolved to the full owner record.

401 · The access token is missing, expired, or does not belong to a property manager.

404 · A property id in the request does not exist for the caller's company.

curl --request POST \ --url 'https://api.portal.magicdoor.com/company-app/owners/distributions/validate' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "propertyIds": [ "1799110447398404096", "1799110447398404098" ] }'

{ "validProperties": [ { "property": { "id": "1799110447398404096", "name": "Sunset Apartments" }, "owners": [ { "ownerId": "1812910038475120640", "ownershipPercentage": 100 } ] } ], "needsAttentionProperties": [ { "property": { "id": "1799110447398404098", "name": "Cedar Court" }, "isMissingOwnerInformation": false, "calculatedOwnershipPercentage": 80, "owners": [ { "ownerId": "1812910038475120641", "ownershipPercentage": 80 } ] } ], "owners": [ { "id": "1812910038475120640", "firstName": "Marisol", "lastName": "Vega", "isCompany": false } ] }