> ## Documentation Index > Fetch the complete documentation index at: https://docs.prov.ae/llms.txt > Use this file to discover all available pages before exploring further. # Screen numbers against the broker register > Tells you which of up to 1000 phone numbers belong to real-estate brokers (agents at other agencies), with the matching broker records. The register is a copy taken at a point in time: some numbers in it are wrong, and some are agency office lines. A number that cannot be read comes back as `invalid` and does not fail the request. Enabled on your credentials separately from the employee check. ## OpenAPI ````yaml /api-reference/openapi.json post /public/phone-screening/brokers openapi: 3.0.3 info: title: Provident — Lead Intake API version: 1.13.0 description: >- Server-to-server API for pushing leads into the Provident CRM. Core endpoints: 1. `POST /oauth2/token` — exchange client credentials for a bearer token. 2. `POST /public/leads` — create a CRM lead. 3. `PUT /public/leads/{id}` — add details you did not have when you created it (quiz answers the customer finished afterwards, a budget, an area). Send only what changed; phones and emails are appended, never replaced, and the lead's stage, status, owner and funnel are not writable. Both the create and the update body accept `comments[]` (max 5 per request, each with its own `date`), which writes a conversation that happened elsewhere onto the lead's thread; the response reports `comments: { added, skipped }` and going over the cap skips rather than fails. Optional read-only reference data, using the same token: locations, developers, projects and project statuses. Use them to send values that match ours, or to show project content on your own pages. They share the lead endpoint's rate limit, so cache them. Optional compliance check, using the same token: `POST /public/dncr/check` checks up to 20 UAE mobile numbers against the UAE Do Not Call Registry before you contact them. Answers are cached for 180 days, and `fresh: true` asks the registry again. Authentication is OAuth 2.0 Client Credentials; there is no user login. Note that the `/v2` prefix is part of the server URL and is mandatory. The intake is deliberately forgiving: name-based lookup fields that cannot be matched do NOT fail the request — the lead is still created and the unmatched values are returned in `intakeUnresolved`. The endpoint is not idempotent at the transport level, but intake hygiene runs before the lead is created: a second enquiry from the same phone/email for the same funnel within the merge window (~24h) is MERGED into the existing lead (its details are folded onto the lead add-only: languages added, phones/emails appended, empty fields filled, nothing overwritten; attribution stays the first enquiry's; an enquiry for a different funnel always becomes its own lead) and returns a different, much shorter 201 body — `{ id, merged: true, matchedOn }` — with no contactId, intakeUnresolved, needsIntakeReview or createdAt. Always branch on `merged` before reading anything else. Enquiries from property-portal sources (Property Finder, Bayut, Dubizzle) are exempt and never merge. Retry only on network timeouts, 429 and 5xx. contact: name: Provident API support servers: - url: https://devapi.prov.ae/v2 description: Staging / development — build and test here - url: https://prodapi.prov.ae/v2 description: Production — live leads security: [] tags: - name: Authentication description: OAuth 2.0 client-credentials token issuance - name: Lead intake description: Public lead creation - name: Reference data description: Read-only lookups — locations, developers, projects, project statuses - name: Lead follow-up description: >- Reading back who a lead was assigned to, and recording the agent response time - name: Do Not Call Registry description: >- Check UAE mobile numbers against the Do Not Call Registry before contacting them - name: Phone screening description: >- Find which phone numbers belong to real-estate brokers or to Provident staff, to take them off a contact list - name: WhatsApp check description: Find out whether phone numbers are on WhatsApp before you message them - name: Webhooks description: >- Calls Provident makes to YOUR server. Documented here for the payload shape; these are not endpoints you call. paths: /public/phone-screening/brokers: post: tags: - Phone screening summary: Screen numbers against the broker register description: >- Tells you which of up to 1000 phone numbers belong to real-estate brokers (agents at other agencies), with the matching broker records. The register is a copy taken at a point in time: some numbers in it are wrong, and some are agency office lines. A number that cannot be read comes back as `invalid` and does not fail the request. Enabled on your credentials separately from the employee check. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PhoneScreeningRequest' example: phones: - '0501234567' - +971 50 765 4321 - '+447700900123' responses: '200': description: One answer per number sent, in the order sent content: application/json: schema: $ref: '#/components/schemas/BrokerScreeningResponse' example: data: - input: '0501234567' phone: '+971501234567' status: match matchCount: 1 matches: - source: dld brokerName: JANE DOE brokerNameAr: جين دو companyName: null brokerNumber: '12345' realEstateNumber: '678' licenseEndDate: '2026-09-04' - input: +971 50 765 4321 phone: '+971507654321' status: no_match matchCount: 0 matches: [] - input: '+447700900123' phone: '+447700900123' status: no_match matchCount: 0 matches: [] meta: requested: 3 unique: 3 invalid: 0 matched: 1 maxNumbersPerRequest: 1000 '400': description: >- `phones` is empty (`PHONE_SCREENING_NO_NUMBERS`) or has more than 1000 numbers (`PHONE_SCREENING_TOO_MANY_NUMBERS`). Nothing was checked. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: statusCode: 400 code: PHONE_SCREENING_TOO_MANY_NUMBERS message: At most 1000 numbers per request; this one had 1001. path: /v2/public/phone-screening/brokers timestamp: '2026-10-19T09:30:02.871Z' details: maxNumbersPerRequest: 1000 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: schemas: PhoneScreeningRequest: type: object required: - phones additionalProperties: false properties: phones: type: array minItems: 1 maxItems: 1000 items: type: string description: >- Phone numbers, at most 1000, as strings. Any country. +971501234567, 00971501234567, 971501234567, 0501234567 and 501234567 are the same number; spaces, dashes and brackets are ignored. A number with no country code and no leading 0 is read as already including its country code, except a 9-digit number starting with 5, which is read as a UAE mobile. example: - '0501234567' - +971 50 765 4321 - '+447700900123' BrokerScreeningResponse: type: object required: - data - meta properties: data: type: array items: $ref: '#/components/schemas/BrokerScreeningResult' description: One row per number sent, in the order sent. meta: $ref: '#/components/schemas/PhoneScreeningMeta' ApiError: type: object description: Common error envelope used by every endpoint. properties: statusCode: type: integer example: 400 code: type: string description: >- Stable machine-readable error code — branch on this, not on `message`. example: BAD_REQUEST message: type: string description: Human-readable description. errors: type: array items: type: string description: 'Present on 422 only: one entry per field that failed validation.' details: type: object additionalProperties: true description: Optional structured extras attached by the failing handler. path: type: string example: /v2/public/leads timestamp: type: string format: date-time BrokerScreeningResult: type: object required: - input - phone - status - matchCount - matches properties: input: type: string description: The number exactly as sent. phone: type: string nullable: true description: International form (+ and digits); null when invalid. example: '+971501234567' status: type: string enum: - match - no_match - invalid description: >- `match`: the number is in this list. `no_match`: a valid number that is not. `invalid`: could not be read as a phone number, not checked. matchCount: type: integer description: >- Broker records holding this number. Can exceed `matches.length`: an agency office line can belong to hundreds of brokers. matches: type: array items: $ref: '#/components/schemas/BrokerMatch' description: Up to 20 matching broker records. PhoneScreeningMeta: type: object required: - requested - unique - invalid - matched - maxNumbersPerRequest properties: requested: type: integer description: Numbers sent. unique: type: integer description: Distinct valid numbers after normalisation. invalid: type: integer matched: type: integer description: Rows in `data` with status `match`. maxNumbersPerRequest: type: integer example: 1000 BrokerMatch: type: object properties: source: type: string enum: - bb - dld description: >- `dld` is the Dubai Land Department broker register; `bb` is a second broker list. brokerName: type: string nullable: true brokerNameAr: type: string nullable: true description: '`dld` records only.' companyName: type: string nullable: true description: Agency name, `bb` records only. brokerNumber: type: string nullable: true description: RERA / DLD broker number. realEstateNumber: type: string nullable: true description: The agency's licence number. licenseEndDate: type: string format: date nullable: true description: '`dld` records only.' responses: Unauthorized: description: Missing, invalid, revoked or expired bearer token. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: statusCode: 401 code: OAUTH_TOKEN_EXPIRED message: OAuth access token expired path: /v2/public/projects/filters timestamp: '2026-07-27T06:31:04.512Z' Forbidden: description: >- Your credentials are not enabled for this endpoint (or your IP is not on the client's allowlist). content: application/json: schema: $ref: '#/components/schemas/ApiError' example: statusCode: 403 code: OAUTH_CLIENT_GRANT_MISSING message: >- This client is not allowed to use this endpoint. It needs the "client:dncr:check:create" grant. details: requiredGrant: client:dncr:check:create path: /v2/public/dncr/check timestamp: '2026-10-06T12:00:00.000Z' ValidationFailed: description: >- A parameter or field failed validation. Note that an UNRECOGNISED query parameter is rejected, not ignored — this is how a call written against the old `page`-based developers endpoint now fails. Fix the request; never retry it unchanged. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: statusCode: 422 code: VALIDATION_ERROR message: Validation failed errors: - property page should not exist path: /v2/public/developers?page=1&limit=2 timestamp: '2026-08-19T07:20:28.507Z' RateLimited: description: >- Request quota for this client exceeded. Wait `Retry-After` seconds, then resume. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/ApiError' example: statusCode: 429 code: RATE_LIMITED message: Too Many Requests path: /v2/public/leads timestamp: '2026-07-27T06:31:04.512Z' headers: XRateLimitLimit: description: Requests allowed in the current window. schema: type: integer XRateLimitRemaining: description: Requests remaining in the current window. schema: type: integer XRateLimitReset: description: Seconds until the counter resets (end of the UTC day). schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Opaque description: >- The `access_token` returned by `POST /oauth2/token`, sent as `Authorization: Bearer `. It is an opaque string, not a JWT. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.