{
  "title": "AccreditedNow API changelog",
  "url": "https://accreditednow.org/changelog",
  "policy": "Changes within /v1 are additive and backward compatible: new fields, events, endpoints and error types may be added, and existing ones are never removed, renamed or retyped. A breaking change would ship under a new version (/v2), announced here and by email to every firm with a live API key before it takes effect. Clients should ignore fields and event types they do not recognize.",
  "updated": "2026-11-22",
  "entries": [
    {
      "date": "2026-11-22",
      "type": "added",
      "title": "Node.js and Python libraries are on npm and PyPI",
      "body": "Install with `npm install accreditednow` or `pip install accreditednow` (version 1.1.1; 1.1.0 was the same code with older install notes). The download links on accreditednow.org/sdk keep working."
    },
    {
      "date": "2026-11-21",
      "type": "changed",
      "title": "Screenings: a full plan returns 409 plan_limit_reached again",
      "body": "The plan move-up added earlier today is withdrawn before any firm used it. When `POST /v1/screenings` would take a firm's list over its monitoring plan, the people are not added and you get `409 plan_limit_reached` (per person in a batch), as before. A firm's plan now changes only when it upgrades on the dashboard, or automatically after a 3-day email notice if it ticked that option; people are never added and later deleted. A free plan with no account activity for 12 months is paused (after an email warning), so calls then return `402 no_active_plan` until the firm turns it back on."
    },
    {
      "date": "2026-11-21",
      "type": "changed",
      "title": "Screenings: plan move-up with 7 days' notice",
      "body": "When `POST /v1/screenings` would take a firm's list over its monitoring plan and the firm has a card on file (and has not turned off plan changes on the dashboard), the people are now added (`201`) instead of refused with `409 plan_limit_reached`, and the firm is emailed a 7-day notice before the plan moves up. If the firm keeps its current plan, or the payment fails, the people added since the notice are deleted: `GET /v1/screenings/{id}` then returns `404` and no webhook is sent. Firms without a card, or with plan changes turned off, get `409 plan_limit_reached` as before."
    },
    {
      "date": "2026-11-21",
      "type": "added",
      "title": "Event feed: GET /v1/events",
      "body": "`GET /v1/events` lists your recent events, newest first: the same envelopes the webhook delivers (`verification.started`, `verification.needs_info`, `verification.completed`, `verification.declined`, `verification.expired`, `letter.reissued`, `verification.reconfirmed` and the `screening.*` events), kept for 30 days whether or not you set up a webhook. Filter with `type` (comma-separated), `limit` (1-100) and `since`. Dedupe on `id`. Status-only keys may read it. Test keys read sandbox events."
    },
    {
      "date": "2026-11-21",
      "type": "added",
      "title": "send_invite on create",
      "body": "`POST /v1/verifications` accepts an optional `send_invite: true`: we email the investor `hosted_url` for you, the same invite the dashboard sends, with up to two automatic reminders if they don't start. Partner-paid single verifications only (`send_invite_unavailable` otherwise). The response then carries `invite {sent, reason, sent_at}`; the create itself never fails because of the invite. At most one invite per investor every 24 hours."
    },
    {
      "date": "2026-11-21",
      "type": "added",
      "title": "Zapier connector 1.1.0",
      "body": "New triggers: Verification Started, Documents Needed, Verification Re-confirmed, Letter Reissued, Screening Completed and Screening Alert (they read the event feed). New action: Add to Monitoring List. Create Verification can send the invite email."
    },
    {
      "date": "2026-11-19",
      "type": "changed",
      "title": "Dates follow Eastern time",
      "body": "A letter now reads `expired` from midnight Eastern time on the day after its expiry date (it used to switch at midnight UTC, which is 7 PM Eastern the evening before). Calendar dates we return, such as the sandbox `expires`, are Eastern dates. Full timestamps (`created`, `verified_at` and event times) are unchanged: ISO 8601 in UTC, as before."
    },
    {
      "date": "2026-11-19",
      "type": "added",
      "title": "verification.needs_info webhook and needs_info fields",
      "body": "A new `verification.needs_info` event is sent when the CPA asks the investor for more documents (it carries `documents_requested_at`, never the CPA's message). Every Verification gains `needs_info` (true while the CPA is waiting) and `documents_requested_at`. In the sandbox, `POST /v1/verifications/{id}/request-documents` simulates it. Additive: ignore the event if you don't need it."
    },
    {
      "date": "2026-11-19",
      "type": "added",
      "title": "Re-confirmation requests through the API",
      "body": "`POST /v1/verifications/{id}/reconfirmation-request` emails a verified investor a link to re-confirm in writing (Rule 506(c)(2)(ii)(E)), the same as the dashboard button. Every Verification gains a `reconfirmation` object (`relies_through`, `last_requested_at`, `last_reconfirmed_at`, `count`), `null` until a letter is issued. New error types: `not_verified`, `reconfirmation_window_expired`, `no_investor_email`, `connected_verification`, `reconfirmation_unavailable`, `reconfirmation_too_soon` (with `error.retry_at`) and `email_failed`."
    },
    {
      "date": "2026-11-19",
      "type": "added",
      "title": "Official Node.js and Python libraries",
      "body": "Dependency-free clients for every endpoint, with automatic `Idempotency-Key` on creates, safe retries, list paging and webhook signature checks. Install with `npm install https://accreditednow.org/sdk/accreditednow-node-1.0.0.tgz` or `pip install https://accreditednow.org/sdk/accreditednow-1.0.0-py3-none-any.whl`."
    },
    {
      "date": "2026-11-18",
      "type": "changed",
      "title": "Monitoring plans and screening-only API open to every firm",
      "body": "Investor-list monitoring plans (free for up to 5 people, then from $9 a month) and the screening-only endpoints (`/v1/screenings`) are now available to every verified firm, not just pilot accounts. Nothing changes for existing integrations; `403 feature_not_enabled` should no longer occur."
    },
    {
      "date": "2026-11-18",
      "type": "changed",
      "title": "Rate limits on certificate lookups",
      "body": "Certificate lookups now have hourly limits to protect investors' information: 60 single lookups per account (and 120 per network address), 300 IDs per account through the batch lookup, and 600 per network address on the public badge endpoint. Over a limit, the endpoint answers HTTP 429 with `{\"status\":\"rate_limited\",\"retryAfter\":<seconds>}` and a `Retry-After` header. The `/v1` API limits are unchanged."
    },
    {
      "date": "2026-11-18",
      "type": "added",
      "title": "Whose income or net worth the letter rests on",
      "body": "The certificate lookup (`/api/verify-certificate`) adds `accreditationBasisDetail` for income and net worth letters: `Individual income`, `Joint income with spouse or spousal equivalent`, `Joint income` (a joint letter), and the same for net worth. It is present only when known; `accreditationBasis` is unchanged. Letters signed from today print the same detail on their basis line."
    },
    {
      "date": "2026-11-16",
      "type": "changed",
      "title": "Shorter streamlined hosted page",
      "body": "The streamlined hosted page is shorter: the page title text, the document checklist under the method question, the longer security panel and the after-you-submit section are gone, the statements instructions are one line, and the note that the investor's letter and status go to your firm now sits inside the confirmation box. A test key's `hosted_url` now previews the page as a partner-paid case. No field, event or error changed.",
      "links": [
        "/verification-api#streamlined"
      ]
    },
    {
      "date": "2026-11-15",
      "type": "changed",
      "title": "Investor-paid cases through your link now share the letter with you",
      "body": "An investor who verifies through your link and pays for it themselves now agrees, before checkout, to share their signed letter and verification status with your firm (an investor who prefers not to share verifies on their own, outside your link). So on these cases started from now on, `letter_available` turns `true` once the letter is issued and `GET /v1/verifications/{id}/letter` returns it, the same as a partner-paid case. No field, event or error changed."
    },
    {
      "date": "2026-11-15",
      "type": "changed",
      "title": "API Terms updated (section 6)",
      "body": "Section 6 of the API Terms now says that, on an investor-paid verification started through your link or hosted page, agreeing to share with you is required for that route, and that an investor can later withdraw that agreement for the future. Your firm will be asked to accept the updated terms on your dashboard."
    },
    {
      "date": "2026-11-12",
      "type": "changed",
      "title": "Details for investors who never start are deleted after 90 days",
      "body": "For a verification the investor never started, the phone, city, state, home street, date of birth and nationality you sent are now deleted 90 days after you last sent them. The record stays and keeps its id, name and email; `investor.city` and `investor.state` then read null."
    },
    {
      "date": "2026-11-12",
      "type": "added",
      "title": "Send the investor's home street: investor.home_street",
      "body": "Optional `investor.home_street` on `POST /v1/verifications` (the street line of the investor's home). On the streamlined hosted page it fills the net-worth home-address question, which the investor sees with the other details on file and can edit. Never printed on the letter or returned. A malformed value is ignored. Like the other streamlined fields, sending it on a partner-paid link opens the streamlined page; send `hosted_page: \"standard\"` to keep the full page."
    },
    {
      "date": "2026-11-12",
      "type": "added",
      "title": "Send the investor's photo ID: POST /v1/verifications/{id}/photo-id",
      "body": "If you already checked an investor's government photo ID, send a copy (`front`, optional `back`; JPEG, PNG, HEIC, WebP or PDF, 3 MB total, base64; the contents must match `content_type`) before the investor submits. The hosted page then shows the ID as received from your firm and doesn't ask for one, and the CPA sees it with the case documents. Returns `{ id, object: \"photo_id\", photo_id_received, files, received_at }`; the file is never returned. A re-send before submission replaces (and deletes) the earlier copy. Retention: on an issued verification the ID is deleted with the other documents 90 days after the letter is issued; on one that is never issued it is deleted 90 days after you sent it; a submitted case keeps it until it is issued or closed, and a case paused with a credit keeps it until the credit expires. New error types: `invalid_photo_id`, `invalid_photo_id_type`, `not_individual`, `413 photo_id_too_large`, `409 case_already_submitted`, `409 case_busy`, `502 upload_failed` / `save_failed`. Full-access keys only; accepts Idempotency-Key. Test keys validate and record the time without storing a file. The streamlined hosted page also now shows one short confirmation sentence and asks about investment property only when the investor says they are counting real estate. Nothing else changed.",
      "action": "Optional. If you don't send an ID, the investor uploads one as before.",
      "links": [
        "/verification-api#photo-id"
      ]
    },
    {
      "date": "2026-11-12",
      "type": "changed",
      "title": "Terms acceptance deadline moved to March 1, 2027",
      "body": "The date from which live verifications and adding a multi-member owner return 403 `terms_not_accepted` (until your firm accepts the current Sponsor Agreement and API Terms in its dashboard) moves from November 18, 2026 to March 1, 2027. Nothing else changed.",
      "action": "Accept the updated terms in your dashboard any time before March 1, 2027.",
      "links": [
        "/verification-api#rest"
      ]
    },
    {
      "date": "2026-11-12",
      "type": "added",
      "title": "Screening reviews: review field, dismiss, screening.reviewed",
      "body": "Screenings gain a `review` field (null until a review is recorded): `outcome` (`different_person` or `possible_same_person`), `note`, `reviewed_by` (`accreditednow` or `you`) and `reviewed_at`. New `POST /v1/screenings/{id}/dismiss` with a `note` marks a PEP or watch-list match you have checked as a different person; a possible sanctions-list match returns `409 sanctions_match`, because we review those ourselves. New webhook event `screening.reviewed` when a review is recorded (people added through the API only). Nothing existing changed.",
      "action": "None. If your webhook consumer rejects unknown event types, let it ignore screening.reviewed.",
      "links": [
        "/verification-api#screenings",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-12",
      "type": "added",
      "title": "Monitoring contact: /v1/screenings/contact",
      "body": "New `GET`, `PUT` and `DELETE /v1/screenings/contact` set who we email about possible matches on your monitored list, besides your account email: `name`, `email`, `phone` and up to 2 `cc` addresses. The same setting is on the Monitoring tab of the dashboard. Nothing existing changed.",
      "action": "None unless you want alerts to reach someone else.",
      "links": [
        "/verification-api#screenings",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-12",
      "type": "changed",
      "title": "basis always matches the signed letter",
      "body": "When the CPA signs (or re-signs) a letter, the verification's `basis` is now saved from the basis printed on that letter. Before, `basis` came from the investor's earlier answers and could differ from the letter in rare cases. The field and its possible values are unchanged.",
      "action": "None.",
      "links": [
        "/verification-api#rest"
      ]
    },
    {
      "date": "2026-11-12",
      "type": "added",
      "title": "Screening only: /v1/screenings",
      "body": "New `POST /v1/screenings` (one person or `{\"people\": [...]}` with up to 100), `GET /v1/screenings`, `GET /v1/screenings/{id}` and `DELETE /v1/screenings/{id}`. Each person is screened against sanctions and PEP lists and then monitored, with no CPA review, no seat and no letter. `date_of_birth` is required. Each person counts toward your firm's monitoring plan. New webhook events `screening.completed` and `screening.alert`, sent only for people added through the API. Test keys return instant sandbox results. Live use is switched on per account. Nothing existing changed: status-only keys can now also read screenings.",
      "action": "None unless you want to use it. If your webhook consumer rejects unknown event types, let it ignore screening.* events.",
      "links": [
        "/verification-api#screenings",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-11",
      "type": "changed",
      "title": "Security: webhook addresses, rate limit, date-of-birth check",
      "body": "Webhook URLs must be a public `https://` address: internal names and private, loopback or link-local IP addresses are now refused when you save the URL and at every delivery. Deliveries follow up to three `307`/`308` redirects (each re-checked); other redirects count as a failed delivery. The 120 requests per minute per key limit is now counted across all our servers, as documented. An optional `investor.date_of_birth` is checked against the investor's uploaded photo ID; if they differ, the sanctions screen runs on name alone and we may contact you about it. No request, response or webhook payload changed.",
      "action": "None for most integrations. If your webhook URL redirects, point it at the final endpoint.",
      "links": [
        "/verification-api#webhook",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-11",
      "type": "added",
      "title": "Streamlined hosted page: send phone, city, state and qualification",
      "body": "`POST /v1/verifications` accepts optional `investor.phone`, `investor.city`, `investor.state` and `qualification` (`income`, `net_worth` or `license`). On a partner-paid link the hosted page fills them in, with the name and email, and doesn't show those fields. The investor uploads documents and a photo ID and confirms. New optional `hosted_page` (`streamlined` or `standard`) chooses the page, and the create response now includes `hosted_page`. New error type `invalid_hosted_page`. A malformed detail is ignored, not rejected. On a verification that hasn't been submitted yet, these details and `investor.first_name` / `investor.last_name` now fill empty fields (existing values are never overwritten).",
      "action": "None for most integrations. If you already send `investor.phone`, `investor.city` or `investor.state` (ignored until now), your partner-paid links now open the streamlined page; send `\"hosted_page\": \"standard\"` to keep the full page.",
      "links": [
        "/verification-api#streamlined",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-11",
      "type": "added",
      "title": "Funds in the API: fund_id, fund, and /v1/funds",
      "body": "`POST /v1/verifications` accepts an optional `fund_id` (one of your funds) to file the verification under that fund. Every verification object, create response and lifecycle webhook now carries `fund` (`{ id, name }` or `null`). `GET /v1/verifications?fund_id=` lists one fund's verifications. New `GET /v1/funds` lists your funds and `POST /v1/funds` adds one (safe to retry: an existing name is returned). New error types `invalid_fund`, `fund_archived` and `funds_busy`. Matching by `deal` name still works when `fund_id` is not sent. Zapier connector 1.0.4 adds a Fund ID input and fund outputs.",
      "action": "None. To group by fund, send `fund_id` on create (ids from `GET /v1/funds`), and ignore `fund` if you don't use funds.",
      "links": [
        "/verification-api#funds",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-11",
      "type": "added",
      "title": "Multiple funds under one sponsor account",
      "body": "A sponsor can now add each fund or deal in the dashboard. Every fund gets its own investor link (`/verify?sponsor=<slug>&fund=<id>`), invites and compliance packet; the firm is verified once and that covers every fund. The embed script accepts an optional `data-fund`. API cases are filed under the fund whose name matches the `deal` name sent on create. No change to API requests, responses or webhooks.",
      "action": "None. To group API cases by fund, send the fund's exact name as `deal` on create.",
      "links": [
        "/verification-api#embed",
        "/sponsors"
      ]
    },
    {
      "date": "2026-11-10",
      "type": "added",
      "title": "Joint verifications: each person's ID check is reported",
      "body": "On a joint verification the second person can now do their own phone ID check (photo of their ID plus a selfie), like the first. `investor.co_investor` gains `identity_verified` (true when the second person passed it), and on a joint case `checks.identity_verified` is now true only when both people passed it, matching the CPA letter. Individual and entity verifications are unchanged.",
      "action": "None, unless you read `checks.identity_verified` on joint cases: it now covers both people.",
      "links": [
        "/verification-api#rest",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-07",
      "type": "changed",
      "title": "Existing letters can also be shared from investor-paid links",
      "body": "\"Use your existing letter\" now also appears on the start page an investor-paid (`billing: \"investor\"`) `hosted_url` opens, before checkout, so an investor who already holds a current letter shares it with you instead of paying again. Nothing else changes: you receive `verification.completed` with `connected: true`, as for a partner-paid link.",
      "action": "None.",
      "links": [
        "/verification-api#rest"
      ]
    },
    {
      "date": "2026-11-07",
      "type": "new",
      "title": "Investors can share an existing letter with you",
      "body": "An investor who already holds a current AccreditedNow letter can share it with your firm instead of verifying again, free and without using a seat. They choose \"Use your existing letter\" on your branded link, embedded flow or a partner-paid (`billing: \"partner\"`) API `hosted_url` and confirm with a code emailed to the address on that verification. Your verification then reads verified with the original letter's dates and certificate, and the new field `connected` is true. You receive `verification.completed` with `connected: true`, plus the later expired, reissued and reconfirmed events for that letter.",
      "action": "None. `connected` is false on every other verification.",
      "links": [
        "/verification-api#rest",
        "/openapi-v1.json"
      ]
    },
    {
      "date": "2026-11-07",
      "type": "new",
      "title": "Postman collection, AsyncAPI document, status page and this changelog",
      "body": "A ready-to-import Postman collection (`postman-v1.json`), an AsyncAPI 3.0 description of every webhook event (`asyncapi-v1.json`, generated from the OpenAPI file), live service status with 90 days of history at /status, and a machine-readable copy of this changelog (`changelog.json`).",
      "action": "None.",
      "links": [
        "/postman-v1.json",
        "/asyncapi-v1.json",
        "/status",
        "/changelog.json"
      ]
    },
    {
      "date": "2026-11-06",
      "type": "new",
      "title": "Embed script: inline or pop-up, with browser events",
      "body": "One script tag (`assets/embed.js` with `data-sponsor` or `data-url`) puts the verification flow inside your page. It sizes itself, can open as a pop-up dialog, and dispatches an `accreditednow` DOM event for `ready`, `resize`, `submitted`, `saved`, `connected`, `done`, `checkout_opened` and more. Events carry no personal data. A plain iframe of `/verify?...&embed=1` still works.",
      "action": "None. Optional: switch a plain iframe to the script tag.",
      "links": [
        "/verification-api#embed"
      ]
    },
    {
      "date": "2026-11-06",
      "type": "fixed",
      "title": "Investor-paid entity and IRA links report back to your verification id",
      "body": "When billing is investor, a single-owner entity, $5M asset-test entity or self-directed IRA that the investor pays for from your `hosted_url` is now linked to your verification id, so status and webhooks reach you as they do for individual and joint cases.",
      "action": "None.",
      "links": [
        "/verification-api#rest"
      ]
    },
    {
      "date": "2026-11-04",
      "type": "changed",
      "title": "API Terms acceptance required for live use from November 18",
      "body": "From November 18, 2026, creating live verifications and adding a multi-member owner return 403 `terms_not_accepted` until your firm has accepted the current Sponsor Agreement and API Terms in its dashboard. Test keys, the sandbox and read endpoints are not affected.",
      "action": "If your dashboard shows an \"accept our updated terms\" card, accept it before November 18, 2026.",
      "links": [
        "/api-terms"
      ]
    },
    {
      "date": "2026-11-03",
      "type": "changed",
      "title": "Self-directed IRAs priced as an individual verification",
      "body": "A self-directed IRA (`entity.type` `sdira`) is reviewed through its owner and is now $99 for an investor-paid link, or one seat. An IRA has one owner, so `entity.type` `sdira` with `entity.structure` `multi_member` returns 400 `invalid_entity_structure`.",
      "action": "None.",
      "links": [
        "/verification-api#rest"
      ]
    },
    {
      "date": "2026-11-02",
      "type": "new",
      "title": "Multi-member entities with owners, and owner changes",
      "body": "Create a multi-member LLC or partnership in one call with `entity.structure` `multi_member` and `owners[]`. Each owner gets their own verification and `hosted_url`. Verification objects and webhooks gain `entity_structure`, `owners`, `requirements` and `entity_verification_ids`. `POST /v1/verifications/{id}/owners` and `DELETE /v1/verifications/{id}/owners/{owner_id}` add or remove an owner before the letter is issued.",
      "action": "None. The new fields are null or empty for other verifications.",
      "links": [
        "/verification-api#rest"
      ]
    },
    {
      "date": "2026-11-02",
      "type": "new",
      "title": "Joint verifications, renewals, verification.reconfirmed and the OpenAPI spec",
      "body": "type: joint with `co_investor` creates one letter for spouses or spousal equivalents. Re-verifying an investor whose earlier verification is finished creates a new verification linked by `renews` and `renewed_by`. A new webhook event, `verification.reconfirmed`, is sent when an investor gives a written re-confirmation within five years. The full API and every webhook are published as OpenAPI 3.1 at `openapi-v1.json`.",
      "action": "None. Ignore event types you do not handle.",
      "links": [
        "/openapi-v1.json",
        "/verification-api#webhook"
      ]
    },
    {
      "date": "2026-11-01",
      "type": "new",
      "title": "Status-only keys, external_id, revision ids and entity details",
      "body": "API keys can be Full or Status only (status-only keys may list and retrieve; other calls return 403 `insufficient_scope`). `external_id` stores your own reference, is returned everywhere and can be filtered with `GET /v1/verifications?external_id=`. Corrections carry `revision` and `revised_at` with event ids ending .r<N>. entity {name, type, registration} on create is returned as `submitted_entity`. `hosted_url` carries an invite code that ties the investor's submission to your verification.",
      "action": "None. Dedupe webhooks on the envelope id and apply the highest `revision`.",
      "links": [
        "/verification-api#rest",
        "/verification-api#webhook"
      ]
    },
    {
      "date": "2026-10-23",
      "type": "new",
      "title": "Self-serve API access, lifecycle webhooks, delivery log and Idempotency-Key",
      "body": "Developers create an account and generate keys at /get-api-access without a sales call. Webhooks gained `verification.started`, `verification.declined`, `verification.expired` and `letter.reissued` alongside `verification.completed`, with a delivery log and one-click resend in the dashboard. `POST /v1/verifications` honors an `Idempotency-Key` header. `investor.date_of_birth` and `investor.nationality` are accepted to sharpen the sanctions screen and are never returned.",
      "action": "None.",
      "links": [
        "/get-api-access",
        "/verification-api#webhook"
      ]
    }
  ]
}
