Consent flow

You never choose which agency you publish for. The agency does, in its own Novi Kvadrat portal, and the result is a connection: one app's grant to push one agency's listings. Every listing call names the connection (/connections/{id}/…), and we check on every request that the connection belongs to the app that signed it.

The flow#

1. The agency connects. An owner or manager opens Integrations → Connections in the agency portal, finds your app under Available software (only live, listed apps appear there), and clicks Connect. The dialog explains what you will be able to do — publish its sale and rental listings, update and remove the listings you published, see the results — and that those listings become read-only in its portal.
2. The agency generates a code. NK-XXXX-XXXX-XXXX: twelve symbols, valid for 15 minutes, usable once, shown only once in that dialog. We never store it in plain text.
3. The agency hands it to you — in your software, by phone, by email.
4. You redeem it with POST /connections { "connect_code": "…" } within 15 minutes. See Redeeming a code.
5. The connection is certifying. The agency gets an email ("… is now connected"); you get the webhook connection.status_changed. Your first pushes wait for our certification.

If the code lapses, the agency generates a new one on the same connection request; the old code stops working at once.

Who can connect#

The agency must be eligible:

• an agency, a solo agent or a bank;
• not suspended or archived;
• with its Register of Brokers number on file (the law requires it on every agency listing; see Legal).

When it is not, redeeming answers 422 agency_not_eligible with details.reason register_number_missing or account_blocked; the agency fixes its profile and gives you a new code.

Sandbox#

On the sandbox there are no real agencies. We attach your sandbox app to a test agency, and the code (valid 24 hours) appears in your Partner Portal under Connections — see Sandbox and the test agency. A sandbox key redeems only sandbox codes, and a live key only codes issued for your live app.