--- title: "ProducerSync API" url: "https://developer.agentsync.io/apis/producer-sync-api/versions/73929b36-7345-4da4-bd67-f8cea6ba3de4" --- # ProducerSync API OpenAPI specification document. ```json {"openapi":"3.1.1","info":{"title":"ProducerSync API","description":"Producer compliance data for the NPNs you monitor — licenses and LOAs, appointments,\nregulatory actions, addresses, contact information, and other names — plus the\nendpoints to manage which producers your account subscribes to.\n\nEvery endpoint requires an OAuth2 client-credentials token and the scope shown on that\nendpoint. See [Authentication](https://developer.agentsync.io/api-authentication) for\nhow to request credentials and retrieve a token,\n[API Base URLs](https://developer.agentsync.io/api-base-urls) for the sandbox and\nproduction hosts, and [Pagination](https://developer.agentsync.io/api-pagination) for\nhow paging works across list endpoints.\n\nUse the sidebar groups to navigate: subscription management is under\n**NPN Management**, and each producer data domain has its own group.\n\n## Webhook events\n\nAgentSync delivers outbound events to your configured endpoint when new compliance\ndata is available and when your monitored population changes. Each event is an HTTP\nPOST whose body carries a unique `id`, a dot-notation `type`, a `timestamp`, and a\n`type`-specific `data` payload; respond `2xx` to acknowledge. The event types are\ndeclared under `webhooks` below.\n\nRegistration, signature verification, retry behaviour and the recommended daily-sync\npattern are documented at\n[ProducerSync API Webhooks](https://developer.agentsync.io/producersync-api-webhooks).\n","version":"v2.86.10"},"servers":[{"url":"https://api.sandbox.agentsync.io","description":"Sandbox"}],"tags":[{"name":"NPN Management","description":"manage the list of subscribed NPNs that your account has access to"},{"name":"Producer Addresses","description":"Address information for producers"},{"name":"Producer Appointments","description":"Appointment information for producers"},{"name":"Producer Contact Information","description":"Contact information for producers"},{"name":"Producer Entities","description":"Entity information for producers"},{"name":"Producer Licenses and LOAs","description":"License and LOA information for producers"},{"name":"Producer Other Names","description":"Other names information for producers"},{"name":"Producer Regulatory Actions","description":"Regulatory actions information for producers"},{"name":"Webhook Events","description":"Outbound events delivered to your configured endpoint when new compliance data is available or your monitored population changes."}],"paths":{"/v1/accounts/subscriptions":{"get":{"tags":["NPN Management"],"operationId":"getActiveNpns","summary":"Get active NPNs subscribed to the account","description":"Returns a list of active NPNs associated with the account.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["1618516","16211","227714","228855","229777","117232"]}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"404":{"$ref":"#/components/responses/404NotFound"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}},"post":{"tags":["NPN Management"],"operationId":"replaceActiveNpns","summary":"Replace the list of active NPNs subscribed to the account","description":"Replaced the current list of active NPNs with the new list provided in the request. This request will delete and add NPNs.\nThis operation is asynchronous\n","requestBody":{"required":true,"description":"The list of NPNs to activate","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["912484758","123456689","999999999"]}}},"responses":{"200":{"description":"Accepted — operation is asynchronous. Use the returned job ID to poll for status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription200"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"timestamp":{"type":"integer","example":1744654402},"message":{"type":"string","example":"Account Not Found"},"path":{"type":"string","example":"/v1/accounts/subscriptions"},"error":{"type":"string","example":"Not Found"}}}}}},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}},"put":{"tags":["NPN Management"],"operationId":"appendActiveNpns","summary":"Append to the list of active NPNs subscribed to the account","description":"Append to the current list of active NPNs with the new list provided in the request.\nThis operation is asynchronous\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["912484758","123456689","999999999"]}}},"responses":{"200":{"description":"Accepted — operation is asynchronous. Use the returned job ID to poll for status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription200"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"timestamp":{"type":"integer","example":1744654402},"message":{"type":"string","example":"Account Not Found"},"path":{"type":"string","example":"/v1/accounts/subscriptions"},"error":{"type":"string","example":"Not Found"}}}}}},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}},"delete":{"tags":["NPN Management"],"operationId":"deleteActiveNpns","summary":"Remove active NPNs subscribed to the account","description":"Request a list of currently active NPNs to un-associated with the account (or delete).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["912484758","123456689","999999999"]}}},"responses":{"202":{"description":"Accepted"},"401":{"$ref":"#/components/responses/401Unauthorized"},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"about:blank"},"status":{"type":"integer","example":415},"detail":{"type":"string","example":"Content-Type 'null' is not supported"},"instance":{"type":"string","example":"/v1/accounts/subscriptions"}}}}}},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/accounts/subscriptions/status/{jobId}":{"get":{"tags":["NPN Management"],"operationId":"getNpnManagementJobStatus","summary":"Get the status for an NPN management job","description":"Returns the status and additional metadata about a specific NPN management job\n","parameters":[{"name":"jobId","in":"path","description":"ID of the job corresponding to the details you are looking for","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"0ded8367-01ac-4519-8cd7-ce965d55c0b0"},"createdAt":{"type":"string","format":"date","example":"2025-04-14","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2025-04-14","description":"Date of the most recent update to this record in AgentSync."},"details":{"type":"object","properties":{"success":{"type":"boolean","example":true},"state":{"type":"string","enum":["SUCCEEDED","FAILED"],"description":"Status of job - `SUCCEEDED`, `FAILED`"},"totalNpns":{"type":"integer","example":3},"queuedNpns":{"type":"integer","example":0},"inProgressNpns":{"type":"integer","example":0},"successfulNpns":{"type":"integer","example":3},"failedNpns":{"type":"integer","example":0}}},"links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}}},"details":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0/details"}}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/accounts/subscriptions/status/{jobId}/details":{"get":{"tags":["NPN Management"],"operationId":"getNpnManagementJobStatusDetails","summary":"Get the status details for an NPN management job","description":"Returns the status details about a specific NPN management job\n","parameters":[{"name":"jobId","in":"path","description":"ID of the job corresponding to the details you are looking for","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"subscriptionJobItem":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILED"],"example":"FAILED","description":"Status of NPN in a job - `SUCCESS`, `FAILED`"},"npn":{"type":"string","example":"229777"},"message":{"type":"string","example":"No producer data found for entity id '{npn}'.","description":"Reason for failure (not present on success)"}}}}}},"links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0/details?page=0&size=250"}}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/addresses":{"get":{"tags":["Producer Addresses"],"operationId":"getAddresses","summary":"Get addresses for subscribed NPNs","description":"Returns all address records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all addresses\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/addresses":{"get":{"tags":["Producer Addresses"],"operationId":"getAddressesByNPN","summary":"Get addresses for a specific NPN","description":"Returns all addresses associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/AddressV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/addresses/{id}":{"get":{"tags":["Producer Addresses"],"operationId":"getAddressById","summary":"Get address by ID","description":"Retrieves a single address record using its unique address ID.\n","parameters":[{"name":"id","in":"path","description":"Unique address ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AddressV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/appointments":{"get":{"tags":["Producer Appointments"],"operationId":"getAppointments","summary":"Get appointments for subscribed NPNs","description":"Returns all appointment records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all appointments\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/coCodesParam"},{"$ref":"#/components/parameters/statusParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"appointments":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentsV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/appointments":{"get":{"tags":["Producer Appointments"],"operationId":"getAppointmentsByNPN","summary":"Get appointments for a specific NPN","description":"Returns all appointments associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/coCodesParam"},{"$ref":"#/components/parameters/statusParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"appointments":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentsV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/appointments/{id}":{"get":{"tags":["Producer Appointments"],"operationId":"getAppointmentById","summary":"Get appointment by ID","description":"Retrieves a single appointment record using its unique address ID.\n","parameters":[{"name":"id","in":"path","description":"Unique appointment ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/AppointmentsV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/contactInfos":{"get":{"tags":["Producer Contact Information"],"operationId":"getContactInfos","summary":"Get contact information for subscribed NPNs","description":"Returns all contact information records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all contact\ninformation for all currently subscribed NPNs. To maximize effectiveness, we strongly\nrecommend using at least one parameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"contactInfos":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfosV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/contactInfos":{"get":{"tags":["Producer Contact Information"],"operationId":"getContactInfosByNPN","summary":"Get contact information for a specific NPN","description":"Returns all contact information associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"contactInfos":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfosV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/contactInfos/{id}":{"get":{"tags":["Producer Contact Information"],"operationId":"getContactInfoById","summary":"Get contact information by ID","description":"Retrieves a single contact information record using its unique contact information ID.\n","parameters":[{"name":"id","in":"path","description":"Unique contact information ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/ContactInfosV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities":{"get":{"tags":["Producer Entities"],"operationId":"getEntities","summary":"Get entities for subscribed NPNs","description":"Returns all entity records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all entities\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntitiesV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/entities/{npn}":{"get":{"tags":["Producer Entities"],"operationId":"getEntitiesByNPN","summary":"Get the entity for a specific NPN","description":"Returns the entity associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/components/schemas/EntitiesV1"}}}},"links":{"$ref":"#/components/schemas/LinksV1"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/licenses":{"get":{"tags":["Producer Licenses and LOAs"],"operationId":"getLicenses","summary":"Get licenses for subscribed NPNs","description":"Returns all license records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all licenses\nfor all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one\nparameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/activeParam"},{"$ref":"#/components/parameters/loaCodesParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/licenseLoas":{"get":{"tags":["Producer Licenses and LOAs"],"operationId":"getLicenseLoas","summary":"Get license line of authorities (LOAs) for subscribed NPNs","description":"Returns all license LOA records for NPNs you are **currently subscribed** to\n","parameters":[{"$ref":"#/components/parameters/licenseIdsParam"},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"embedded":{"$ref":"#/components/schemas/LicenseLoaV2"},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/licenses/{licenseId}/licenseLoas":{"get":{"tags":["Producer Licenses and LOAs"],"operationId":"getLicenseLoasByLicenseId","summary":"Get license line of authorities for an associated license","description":"Returns all license line of authorities associated with a unique license ID\n","parameters":[{"$ref":"#/components/parameters/licenseIdPathParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"$ref":"#/components/schemas/LicenseLoaV2"},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/licenses":{"get":{"tags":["Producer Licenses and LOAs"],"operationId":"getLicensesByNpn","summary":"Get license for a specific NPN","description":"Returns all licenses associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/activeParam"},{"$ref":"#/components/parameters/loaCodesParam"},{"$ref":"#/components/parameters/loaCategoriesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"licenses":{"type":"array","items":{"$ref":"#/components/schemas/LicensesV2Response"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/licenses/{id}":{"get":{"tags":["Producer Licenses and LOAs"],"operationId":"getLicenseById","summary":"Get licenses by ID","description":"Retrieves a single license record using its unique license ID.\n","parameters":[{"name":"id","in":"path","description":"Unique license ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/LicensesV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/licenseLoas/{id}":{"get":{"tags":["Producer Licenses and LOAs"],"operationId":"getLicenseLoaById","summary":"Get license line of authority by ID","description":"Retrieves a single line of authority record using its unique loa ID.\n","parameters":[{"name":"id","in":"path","description":"Unique line of authority ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/LicenseLoaV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/otherNames":{"get":{"tags":["Producer Other Names"],"operationId":"getOtherNamesForSubscribedNpns","summary":"Get other names for subscribed NPNs","description":"Returns all other names records for NPNs you are **currently subscribed** to.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"otherNames":{"type":"array","items":{"$ref":"#/components/schemas/OtherNamesV2"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/otherNames":{"get":{"tags":["Producer Other Names"],"operationId":"getOtherNamesForSpecificNpn","summary":"Get other names for a specific NPN","description":"Returns all other names associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"otherNames":{"type":"array","items":{"$ref":"#/components/schemas/OtherNamesV2"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/otherNames/{id}":{"get":{"tags":["Producer Other Names"],"operationId":"getOtherNameByIdV1","summary":"Get other names by ID","description":"Retrieves a single other names record using its unique other names ID.\n","parameters":[{"name":"id","in":"path","description":"Unique other names ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/OtherNamesV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/regulatoryActions":{"get":{"tags":["Producer Regulatory Actions"],"operationId":"getRegulatoryActionsForSubscribedNpns","summary":"Get regulatory actions for subscribed NPNs","description":"Returns all regulatory actions records for NPNs you are **currently subscribed** to.\n\nIf no query parameters are provided in the request, then the response will include all\nregulatory actions for all currently subscribed NPNs. To maximize effectiveness, we strongly\nrecommend using at least one parameter to narrow your results.\n","parameters":[{"$ref":"#/components/parameters/npnsParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"regulatoryActions":{"type":"array","items":{"$ref":"#/components/schemas/RegulatoryActionsV2"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/regulatoryActions/{id}/regulatoryActionValues":{"get":{"tags":["Producer Regulatory Actions"],"operationId":"getRegulatoryActionValues","summary":"Get regulatory action values for a specific regulatory action","description":"Returns all regulatory actions value records for ID of a given regulatory action.\n","parameters":[{"name":"id","in":"path","description":"Unique regulatory actions ID","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/sizeParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"regulatoryActionValues":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/RegulatoryActionValuesV2"},{"$ref":"#/components/schemas/SelfLink"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]}}}}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v2/entities/{npn}/regulatoryActions":{"get":{"tags":["Producer Regulatory Actions"],"operationId":"getRegulatoryActionsByNpn","summary":"Get regulatory actions for a specific NPN","description":"Returns all regulatory actions associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.\n","parameters":[{"$ref":"#/components/parameters/npnPathParam"},{"$ref":"#/components/parameters/statesParam"},{"$ref":"#/components/parameters/updatedSinceParam"},{"$ref":"#/components/parameters/includeDeletedParam"},{"$ref":"#/components/parameters/sizeParam"},{"$ref":"#/components/parameters/continuationTokenParam"}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"type":"object","properties":{"embedded":{"type":"object","properties":{"regulatoryActions":{"type":"array","items":{"$ref":"#/components/schemas/RegulatoryActionsV2"}}}},"links":{"$ref":"#/components/schemas/LinksV2"}}}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/regulatoryActions/{id}":{"get":{"tags":["Producer Regulatory Actions"],"operationId":"getRegulatoryActionsById","summary":"Get regulatory actions by ID","description":"Retrieves a single regulatory actions record using its unique regulatory actions ID.\n","parameters":[{"name":"id","in":"path","description":"Unique regulatory actions ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/RegulatoryActionsV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}},"/v1/regulatoryActionValues/{id}":{"get":{"tags":["Producer Regulatory Actions"],"operationId":"getRegulatoryActionValuesById","summary":"Get regulatory action values by ID","description":"Retrieves a single regulatory action value record using its unique regulatory action value ID.\n","parameters":[{"name":"id","in":"path","description":"Unique regulatory action value ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/RegulatoryActionValuesV1"}}},"headers":{"ratelimit-limit":{"$ref":"#/components/headers/ratelimit-limit"},"ratelimit-remaining":{"$ref":"#/components/headers/ratelimit-remaining"},"ratelimit-reset":{"$ref":"#/components/headers/ratelimit-reset"}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"405":{"$ref":"#/components/responses/405MethodNotAllowed"},"429":{"$ref":"#/components/responses/429TooManyRequests"},"500":{"$ref":"#/components/responses/500InternalServerError"},"504":{"$ref":"#/components/responses/504GatewayTimeout"}}}}},"webhooks":{"producerSyncUpdatesAvailable":{"post":{"security":[],"summary":"Updates Available","operationId":"onProducerSyncUpdatesAvailable","description":"Fires **once per day**, after AgentSync has finished processing NIPR's refresh\nacross your entire monitored population.\n\nThis is a batch-complete signal, not a per-producer one. There is no event for an\nindividual NPN, and the payload carries only a `runDate` — no NPN — because the\nevent means \"every producer you monitor has been processed\", not \"this producer\nchanged\". NIPR publishes once daily, so this is the cadence at which compliance\ndata can change at all.\n\nUse `data.runDate` as the value for the `updatedSince` parameter to fetch just the\nrecords that changed.\n","tags":["Webhook Events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatesAvailableWebhookEvent"},"example":{"id":"whe_01m0a149wzf6sb9ap9y8tafwe1","type":"producersync.updates_available","timestamp":"2026-08-18T08:52:09.2471298Z","data":{"runDate":"2026-08-18"}}}}},"responses":{"2XX":{"description":"Customer endpoint acknowledged the event."}}}},"producerSyncNpnActivated":{"post":{"security":[],"summary":"NPN Activated","operationId":"onProducerSyncNpnActivated","description":"Delivered when a producer is added to your monitored population.\n\nFires immediately — it is triggered by a change to your account's subscription\nlist, not by NIPR's daily cycle. Use it to start onboarding workflows or run an\ninitial compliance check.\n","tags":["Webhook Events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpnActivatedWebhookEvent"},"example":{"id":"whe_01m0as71hne038rrhtz1w36n77","type":"producersync.npn.activated","timestamp":"2026-08-18T15:53:04.8213402Z","data":{"npn":"15645555","activatedAt":"2026-08-18T15:53:01.5791204Z"}}}}},"responses":{"2XX":{"description":"Customer endpoint acknowledged the event."}}}},"producerSyncNpnDeactivated":{"post":{"security":[],"summary":"NPN Deactivated","operationId":"onProducerSyncNpnDeactivated","description":"Delivered when a producer is removed from your monitored population.\n\nFires immediately — it is triggered by a change to your account's subscription\nlist, not by NIPR's daily cycle. Use it to remove the producer from active\nmonitoring or trigger offboarding actions.\n","tags":["Webhook Events"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpnDeactivatedWebhookEvent"},"example":{"id":"whe_01m0b4z12te08trj6a0dnq03k1","type":"producersync.npn.deactivated","timestamp":"2026-08-18T19:18:25.114073Z","data":{"npn":"15645555","deactivatedAt":"2026-08-18T19:18:22.982Z"}}}}},"responses":{"2XX":{"description":"Customer endpoint acknowledged the event."}}}}},"components":{"schemas":{"LoaMapping":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"},"example":["property","health","casualty"]}}},"SelfLink":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/{endpoint}/{id}"}}}}},"LinksV1":{"type":"object","properties":{"first":{"type":"object","properties":{"href":{"type":"string","example":"https://access.sandbox.agentsync.io/v1/{endpoint}?page=0&size=3"}}},"self":{"type":"object","properties":{"href":{"type":"string","example":"https://access.sandbox.agentsync.io/v1/{endpoint}?page=0&size=3"}}},"next":{"type":"object","properties":{"href":{"type":"string","example":"https://access.sandbox.agentsync.io/v1/{endpoint}?page=1&size=3"}}},"last":{"type":"object","properties":{"href":{"type":"string","example":"https://access.sandbox.agentsync.io/v1/{endpoint}?page=164&size=3"}}}}},"LinksV2":{"type":"object","properties":{"next":{"type":"object","properties":{"href":{"type":"string","example":"https://access.sandbox.agentsync.io/v2/{endpoint}?continuationToken=1282784"}}},"self":{"type":"object","properties":{"href":{"type":"string","example":"https://access.sandbox.agentsync.io/v2/{endpoint}?continuationToken=0"}}}}},"Subscription200":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"Job is in progress"},"job_id":{"type":"string","example":"0ded8367-01ac-4519-8cd7-ce965d55c0b0"},"links":{"type":"object","properties":{"status":{"type":"object","properties":{"href":{"type":"string","example":"https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}}}}}}},"AddressBaseResponse":{"type":"object","description":"Common address fields shared across versions.","properties":{"id":{"type":"integer","format":"int64","example":1234567,"description":"Unique identifier for the address."},"npn":{"type":"string","example":"18551108","description":"National Producer Number associated with the address."},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"type":{"type":"string","enum":["BUSINESS","MAILING","RESIDENCE"],"example":"BUSINESS","description":"Type of address. One of `BUSINESS`, `MAILING`, `RESIDENCE`"},"forState":{"type":"string","example":"AL","minLength":2,"maxLength":2,"description":"State where the address applies."},"branchId":{"type":"string","example":"","description":"Identifier for a related branch, if applicable."},"niprDateUpdated":{"type":"string","format":"date","example":"2024-12-01","description":"Last date NIPR reported an update to this address."},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"line1":{"type":"string","example":"789 S Washington Ave","description":"Street address."},"line2":{"type":"string","example":"Suite 400","description":"Second line of the street address, such as a suite or unit."},"line3":{"type":"string","example":"Building C","description":"Third line of the street address."},"city":{"type":"string","example":"Denver","description":"City of the address."},"state":{"type":"string","example":"CO","description":"State of the address."},"zip":{"type":"string","example":"80211","description":"ZIP or postal code."},"country":{"type":"string","example":"U.S.A.","description":"Country of the address."},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the address was marked deleted by NIPR."}}},"AddressV2Response":{"allOf":[{"$ref":"#/components/schemas/AddressBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"AddressV1":{"allOf":[{"$ref":"#/components/schemas/AddressBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"AppointmentsBaseResponse":{"type":"object","description":"Base schema containing common appointment fields.","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the appointment.","example":1234567},"npn":{"type":"string","description":"National Producer Number associated with the appointment.","example":"18551108"},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"forState":{"type":"string","description":"Two-letter state code where the appointment applies.","example":"AL","minLength":2,"maxLength":2},"branchId":{"type":"string","description":"Optional branch identifier.","example":""},"companyName":{"type":"string","description":"Name of the appointing insurance company.","example":"My Insurance Company"},"feinId":{"type":"string","description":"Federal Employer Identification Number (FEIN) of the company.","example":""},"coCode":{"type":"string","description":"5-digit company code.","example":"98765","minLength":5,"maxLength":5},"loa":{"type":"string","description":"Line of Authority (LOA) name.","example":"Property"},"loaCode":{"type":"string","description":"Line of Authority code (may be numeric or alphanumeric).","example":"12"},"status":{"type":"string","description":"Appointment status (e.g., Active, Terminated).","example":"Terminated"},"statusReasonDate":{"type":"string","format":"date","description":"Date when the current status took effect.","example":"2024-02-29"},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"terminationReason":{"type":"string","description":"Reason for termination, if applicable.","example":"Not for Cause"},"renewalDate":{"type":"string","format":"date","description":"Renewal date for the appointment, as reported by NIPR.","example":"2025-04-01"},"agencyName":{"type":"string","description":"Name of the appointed agency. Distinct from `companyName`, which is the company appointed to.","example":"My Insurance Agency"},"agencyStateCoId":{"type":"string","description":"State-assigned company ID of the appointed agency in `agencyName`.","example":"294553"},"countyCode":{"type":"string","description":"Optional county code.","example":""},"loaMapping":{"$ref":"#/components/schemas/LoaMapping"},"niprDeleted":{"type":"boolean","description":"Indicates if the appointment is marked as deleted by NIPR.","example":false}}},"AppointmentsV2Response":{"allOf":[{"$ref":"#/components/schemas/AppointmentsBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"AppointmentsV1":{"allOf":[{"$ref":"#/components/schemas/AppointmentsBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"ContactInfosBaseResponse":{"type":"object","description":"Common contact information fields shared across versions.","properties":{"id":{"type":"integer","format":"int64","example":1234567,"description":"Unique identifier for the contact information."},"npn":{"type":"string","example":"18551108","description":"National Producer Number associated with the contact information."},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"type":{"type":"string","enum":["BUSINESS_PHONE","BUSINESS_EMAIL","FAX"],"example":"BUSINESS_EMAIL","description":"Type of contact information."},"forState":{"type":"string","example":"AL","minLength":2,"maxLength":2,"description":"State where the contact information applies."},"branchId":{"type":"string","example":"","description":"Identifier for a related branch, if applicable."},"niprDateUpdated":{"type":"string","format":"date","example":"2024-12-01","description":"Last date NIPR reported an update to this contact information."},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"value":{"type":"string","description":"The contact information itself (phone number, email, etc.)","example":"apis.rock@agentsync.io"},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the contact information was marked deleted by NIPR."}}},"ContactInfosV2Response":{"allOf":[{"$ref":"#/components/schemas/ContactInfosBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"ContactInfosV1":{"allOf":[{"$ref":"#/components/schemas/ContactInfosBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"EntitiesBaseResponse":{"type":"object","description":"Common entity fields shared across versions.","properties":{"id":{"type":"integer","format":"int64","example":1234567,"description":"Unique identifier for the entity."},"npn":{"type":"string","example":"18551108","description":"National Producer Number associated with the entity."},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"type":{"type":"string","enum":["INDIVIDUAL","FIRM"],"example":"INDIVIDUAL","description":"Type of entity - individual or firm."},"feinId":{"type":["string","null"],"example":"123456789","description":"Federal Employer Identification Number. Expected to be NULL for individuals."},"companyName":{"type":["string","null"],"example":"Acme Insurance Group","description":"Name of the firm. Expected to be NULL for individuals."},"stateCoId":{"type":"string","example":"294553","description":"State-assigned company ID of the firm. Expected to be absent for individuals."},"stateDomicile":{"type":"string","example":"CO","minLength":2,"maxLength":2,"description":"Code of the state the firm is domiciled in. Expected to be absent for individuals."},"firstName":{"type":"string","example":"Jeff"},"middleName":{"type":"string","example":"Lee"},"lastName":{"type":"string","example":"Android"},"suffix":{"type":"string","example":"Jr","description":"Name suffix for the producer. Expected to be absent for a firm."},"dateOfBirth":{"type":["string","null"],"format":"date","example":"1983-12-15","description":"Date of birth for the producer. Expected to be NULL for a firm."},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"noLicenses":{"type":"boolean","example":false},"subscriptionCount":{"type":"integer","example":4},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the entity was marked deleted by NIPR."}}},"EntitiesLinks":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"https://api.sandbox.agentsync.io/v1/entities/1000013"}}},"addresses":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"https://api.sandbox.agentsync.io/v1/entities/1000013/addresses"}}},"contactInfos":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"https://api.sandbox.agentsync.io/v1/entities/1000013/contactInfos"}}},"appointments":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"https://api.sandbox.agentsync.io/v1/entities/1000013/appointments"}}},"licenses":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"https://api.sandbox.agentsync.io/v1/entities/1000013/licenses"}}},"residentLicense":{"type":"object","properties":{"href":{"type":"string","format":"uri","example":"https://api.sandbox.agentsync.io/v2/entities/1000013/residentLicense"}}}}},"EntitiesV2Response":{"allOf":[{"$ref":"#/components/schemas/EntitiesBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/EntitiesLinks"}}}]},"EntitiesV1Metadata":{"type":"object","properties":{"no_licenses":{"type":"boolean","example":false},"last_nipr_entity_update":{"type":"string","format":"date-time","example":"2024-11-20T12:42:43.519662+00:00"}}},"EntitiesV1":{"allOf":[{"$ref":"#/components/schemas/EntitiesBaseResponse"},{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/EntitiesV1Metadata"},"links":{"$ref":"#/components/schemas/EntitiesLinks"}}}]},"LicensesBaseResponse":{"type":"object","description":"Base schema containing common license fields.","properties":{"id":{"type":"integer","format":"int64","example":1234567,"description":"Unique identifier for the license."},"npn":{"type":"string","example":"18551108","description":"National Producer Number associated with the license."},"transactionId":{"type":"string","format":"uuid","example":"337f638b-b0dd-4d9f-80f5-29a9158d0286"},"forState":{"type":"string","example":"AL","minLength":2,"maxLength":2,"description":"State where the license applies."},"branchId":{"type":"string","example":"","description":"Identifier for a related branch, if applicable."},"niprDateUpdated":{"type":"string","format":"date","example":"2020-12-16","description":"Last date NIPR reported an update to this license."},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"licenseNum":{"type":"string","example":"897579550","description":"License number associated with NPN."},"originalIssueDate":{"type":"string","format":"date","example":"2016-04-22","description":"The date the license was originally issued"},"expirationDate":{"type":"string","format":"date","example":"2022-04-22","description":"The date the license is set to expire."},"licenseClass":{"type":"string","example":"Insurance Producer","description":"The classification or type of license issued"},"licenseClassCode":{"type":"string","example":"3","description":"The code representing the license class"},"residencyStatus":{"type":"string","example":"R","description":"Indicates whether the license holder is a resident (\"R\") or non-resident (\"NR\")"},"active":{"type":"boolean","example":false,"description":"Indicates whether the license is currently active"},"adhsHomeState":{"type":"string","example":"TX","minLength":2,"maxLength":2,"description":"Adjuster Designated Home State - the state the producer designated as their home state for adjuster\nlicensing. Populated only when the state reports one.\n"}}},"LicenseLoaBase":{"type":"object","properties":{"id":{"type":"integer","example":1234567,"description":"unique identifier for the license line of authority (loa) record"},"licenseId":{"type":"integer","description":"unique identifier for the associated license","example":967373},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"loa":{"type":"string","example":"Property","description":"The line of authority associated with the license (e.g., Property, Casualty)"},"loaCode":{"type":"string","example":"12","description":"A code representing the line of authority"},"issueDate":{"type":"string","format":"date","example":"2004-01-21","description":"The date the line of authority was issued"},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync"},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync"},"status":{"type":"string","enum":["Active","Cancelled","Inactive"],"example":"Active","description":"Current status of the line of authority. One of `Active`, `Cancelled`, or `Inactive`"},"statusReason":{"type":"string","description":"Reason from the state explaining the current `status`, such as why a line of authority is inactive or\ncancelled. Free text passed through from NIPR - not a fixed set of values, and often absent.\n"},"statusReasonDate":{"type":"string","format":"date","example":"2020-12-26","description":"The date the current status reason became effective"},"ceCompliance":{"type":"string","example":"IN COMPLIANCE","description":"Continuing education (CE) compliance status. One of `EXEMPT`, `IN COMPLIANCE`, `N/A`, `NOT IN COMPLIANCE` or `NULL`"},"ceRenewalDate":{"type":"string","format":"date","example":"2026-03-31","description":"Date by which continuing education credits must be completed for this line of authority."},"ceCreditsNeeded":{"type":"integer","example":0,"description":"Number of continuing education credits required for compliance"},"loaMapping":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string","example":"life"}}}},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the license was marked deleted by NIPR"}}},"LicenseLoaV2":{"type":"object","description":"Container for a list of license records in version 2","properties":{"licenseLoas":{"type":"array","description":"A list of license objects","items":{"allOf":[{"$ref":"#/components/schemas/LicenseLoaBase"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]}}}},"RenewalPeriodsBase":{"type":"object","description":"Contains calculated renewal windows and classification","properties":{"renewal":{"type":"object","properties":{"startDate":{"type":"string","format":"date","example":"2025-10-02"},"endDate":{"type":"string","format":"date","example":"2025-12-31"}}},"lateRenewal":{"type":"object","properties":{"startDate":{"type":"string","format":"date","example":"2026-01-01"},"endDate":{"type":"string","format":"date","example":"2026-01-30"}}},"reinstatement":{"type":"object","properties":{"startDate":{"type":"string","format":"date","example":"2026-01-31"},"endDate":{"type":"string","format":"date","example":"2026-12-31"}}},"renewalType":{"type":"string","enum":["RENEWAL_REQUIRED","PERPETUAL","NO_RENEWAL_INFORMATION_AVAILABLE"],"example":"RENEWAL_REQUIRED","description":"Classification of the license renewal behavior.\n- `RENEWAL_REQUIRED`: License has defined renewal windows.\n- `PERPETUAL`: License is considered perpetual.\n- `NO_RENEWAL_INFORMATION_AVAILABLE`: No renewal metadata matched (due to various reasons).\n"}}},"LicensesV2Response":{"allOf":[{"$ref":"#/components/schemas/LicensesBaseResponse"},{"type":"object","properties":{"licenseLoas":{"type":"array","items":{"$ref":"#/components/schemas/LicenseLoaV2"}},"agentTypes":{"type":"array","items":{"type":"string","example":"Producer"}},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the license was marked deleted by NIPR."},"links":{"$ref":"#/components/schemas/SelfLink"},"renewalPeriods":{"$ref":"#/components/schemas/RenewalPeriodsBase"}}}]},"LicenseLoaV1":{"allOf":[{"$ref":"#/components/schemas/LicenseLoaBase"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"LicensesV1":{"allOf":[{"$ref":"#/components/schemas/LicensesBaseResponse"},{"type":"object","properties":{"licenseLoas":{"type":"array","items":{"$ref":"#/components/schemas/LicenseLoaV1"}},"agentTypes":{"type":"array","items":{"type":"string","example":"Producer"}},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the license was marked deleted by NIPR."},"links":{"$ref":"#/components/schemas/SelfLink"},"renewalPeriods":{"$ref":"#/components/schemas/RenewalPeriodsBase"}}}]},"OtherNamesBaseResponse":{"type":"object","description":"Common other names fields shared across versions.","properties":{"id":{"type":"integer","format":"int64","example":1234567,"description":"Unique identifier for the contact information."},"npn":{"type":"string","example":"18551108","description":"National Producer Number associated with the contact information."},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"type":{"type":"string","enum":["ALIAS","FIRM_BRANCH","PREVIOUS"],"example":"ALIAS","description":"Type of other name. One of `ALIAS`, `FIRM_BRANCH`, `PREVIOUS`"},"forState":{"type":"string","example":"AL","minLength":2,"maxLength":2,"description":"State where the other name applies."},"branchId":{"type":"string","example":"","description":"Identifier for a related branch, if applicable."},"stateCoId":{"type":"string","example":"294553","description":"State company ID"},"name":{"type":"string","example":"My Underwriters Inc","description":"The other name."},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the contact information was marked deleted by NIPR."}}},"OtherNamesV2":{"allOf":[{"$ref":"#/components/schemas/OtherNamesBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"OtherNamesV1":{"allOf":[{"$ref":"#/components/schemas/OtherNamesBaseResponse"},{"type":"object","properties":{"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"RegulatoryActionsBaseResponse":{"type":"object","description":"Common regulatory actions fields shared across versions.","properties":{"id":{"type":"integer","format":"int64","example":1234567,"description":"Unique identifier for the regulatory actions."},"npn":{"type":"string","example":"18551108","description":"National Producer Number associated with the regulatory actions."},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"forState":{"type":"string","example":"AL","minLength":2,"maxLength":2,"description":"State where the regulatory action applies."},"actionId":{"type":"string","example":"13537078","description":"Identification of the regulatory action."},"actionDate":{"type":"string","format":"date","example":"2017-07-10","description":"The date the regulatory action occurred."},"effectiveDate":{"type":"string","format":"date","example":"2017-07-10","description":"The date the regulatory action is effective"},"enterDate":{"type":"string","format":"date","example":"2018-02-08","description":"The date the regulatory action was entered in the jurisdiction system."},"fileRef":{"type":"string","example":"123","description":"File reference identifier for the regulatory action, as reported by the jurisdiction. Format varies by\nstate.\n"},"createdAt":{"type":"string","format":"date","example":"2021-04-04","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-12-02","description":"Date of the most recent update to this record in AgentSync."},"penaltyFineForfeiture":{"type":"integer","example":150,"description":"Amount in USD of fine, if applicable."},"lengthOfOrder":{"type":"integer","example":30,"description":"The sanction period."}}},"RegulatoryActionValuesBase":{"type":"object","description":"All regulatory actions should have three associated child objects - disposition, origin, and reason","properties":{"id":{"type":"integer","example":123,"description":"Unique identifier for the regulatory action value."},"regulatoryActionId":{"type":"integer","example":1234567,"description":"Unique identifier for the related regulatory action."},"transactionId":{"type":"string","format":"uuid","example":"ae51f10b-8b5e-40ba-98a9-8f860392b344"},"type":{"type":"string","enum":["REASON","ORIGIN","DISPOSITION"],"example":"DISPOSITION","description":"One of the following values is expected per object - `REASON`, `ORIGIN`, `DISPOSITION`"},"value":{"type":"string","example":"Cease And Desist","description":"Description of the related regulatory action"},"createdAt":{"type":"string","format":"date","example":"2021-03-23","description":"Date of the creation of this record in AgentSync."},"updatedAt":{"type":"string","format":"date","example":"2024-04-16","description":"Date of the most recent update to this record in AgentSync"}}},"RegulatoryActionValuesV2":{"type":"object","properties":{"regulatoryActionValues":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/RegulatoryActionValuesBase"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"last_nipr_alert_update":{"type":"string","format":"date-time","example":"2024-01-20T10:54:35.30506+00:00"},"last_nipr_entity_update":{"type":"string","format":"date-time","example":"2024-04-16T22:58:09.398811+00:00"}}},"deleted":{"type":"boolean","example":true}}}]}}}},"RegulatoryActionsV2":{"allOf":[{"$ref":"#/components/schemas/RegulatoryActionsBaseResponse"},{"type":"object","properties":{"regulatoryActionValues":{"$ref":"#/components/schemas/RegulatoryActionValuesV2"},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the regulatory actions was marked deleted by NIPR."},"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"RegulatoryActionValuesV1":{"allOf":[{"$ref":"#/components/schemas/RegulatoryActionValuesBase"},{"type":"object","properties":{"metadata":{"type":"object","properties":{"last_nipr_alert_updated":{"type":"string"},"last_nipr_entity_update":{"type":"string"}}},"deleted":{"type":"boolean","example":true}}}]},"RegulatoryActionsV1":{"allOf":[{"$ref":"#/components/schemas/RegulatoryActionsBaseResponse"},{"type":"object","properties":{"regulatoryActionValues":{"$ref":"#/components/schemas/RegulatoryActionValuesV1"},"niprDeleted":{"type":"boolean","example":false,"description":"Indicates if the regulatory actions was marked deleted by NIPR."},"links":{"$ref":"#/components/schemas/SelfLink"}}}]},"WebhookEventEnvelope":{"type":"object","description":"Fields common to every ProducerSync webhook event.","required":["id","type","timestamp"],"properties":{"id":{"type":"string","description":"Unique identifier for this event, a TypeID with the `whe_` prefix. Repeated on retries — use it to deduplicate.","example":"whe_01m0a149wzf6sb9ap9y8tafwe1"},"type":{"type":"string","description":"The specific event type."},"timestamp":{"type":"string","format":"date-time","description":"UTC time the event was generated. Fractional-second precision is not fixed - parse with a tolerant RFC 3339 parser rather than a fixed-millisecond format.","example":"2026-08-18T08:52:09.2471298Z"}}},"UpdatesAvailableEventData":{"type":"object","required":["runDate"],"properties":{"runDate":{"type":"string","format":"date","description":"The NIPR run date the completed batch covers. Pass this as `updatedSince` to fetch only the records that changed.","example":"2025-07-24"}}},"UpdatesAvailableWebhookEvent":{"allOf":[{"$ref":"#/components/schemas/WebhookEventEnvelope"},{"type":"object","required":["data"],"properties":{"type":{"const":"producersync.updates_available"},"data":{"$ref":"#/components/schemas/UpdatesAvailableEventData"}}}]},"NpnActivatedEventData":{"type":"object","required":["npn","activatedAt"],"properties":{"npn":{"type":"string","description":"The National Producer Number added to your monitored population.","example":"15645555"},"activatedAt":{"type":"string","format":"date-time","description":"UTC time the NPN became active on your account.","example":"2026-08-18T15:53:01.579Z"}}},"NpnActivatedWebhookEvent":{"allOf":[{"$ref":"#/components/schemas/WebhookEventEnvelope"},{"type":"object","required":["data"],"properties":{"type":{"const":"producersync.npn.activated"},"data":{"$ref":"#/components/schemas/NpnActivatedEventData"}}}]},"NpnDeactivatedEventData":{"type":"object","required":["npn","deactivatedAt"],"properties":{"npn":{"type":"string","description":"The National Producer Number removed from your monitored population.","example":"15645555"},"deactivatedAt":{"type":"string","format":"date-time","description":"UTC time the NPN was deactivated on your account.","example":"2026-08-18T19:18:22.982Z"}}},"NpnDeactivatedWebhookEvent":{"allOf":[{"$ref":"#/components/schemas/WebhookEventEnvelope"},{"type":"object","required":["data"],"properties":{"type":{"const":"producersync.npn.deactivated"},"data":{"$ref":"#/components/schemas/NpnDeactivatedEventData"}}}]}},"parameters":{"npnPathParam":{"name":"npn","in":"path","description":"National Producer Number (npn) of the data to return","required":true,"schema":{"type":"string","example":"123456789"}},"npnsParam":{"name":"npns","in":"query","description":"comma separated list of National Producer Numbers (NPNs)","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"example":["123456789","987654321"]},"statesParam":{"name":"states","in":"query","description":"comma separated list of states abbreviations (must be 2 characters) - this will filter on the `forState` field","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"example":["MO","CA","CO"]},"includeDeletedParam":{"name":"includeDeleted","in":"query","description":"specifiy whether or not deleted records should be included in the response - this will filter on the `niprDeleted` field","required":false,"schema":{"type":"boolean","default":true}},"loaCategoriesParam":{"name":"loaCategories","in":"query","description":"comma seperated list of loa categories - this will filter on the `loaMapping.categories` array (it will return all records containing at least one of the values passed)","required":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"example":["casualty","property"]},"updatedSinceParam":{"name":"updatedSince","in":"query","description":"limits results to those that have an updated date equivalent to or after to the date provided (YYYY-MM-DD) - this will filter on the `updatedAt` field","required":false,"schema":{"type":"string","format":"date","example":"2024-10-15"}},"sizeParam":{"name":"size","in":"query","description":"the number of objects on the page (min = 1 / max = 1,000)","required":false,"schema":{"type":"integer","format":"int64","default":250,"minimum":1,"maximum":1000}},"continuationTokenParam":{"name":"continuationToken","in":"query","description":"Token for fetching the next page of results","required":false,"schema":{"type":"string"}},"coCodesParam":{"name":"coCodes","in":"query","description":"comma separated list of company/co codes (must by 5 digits) - this will filter on the `coCode` field","required":false,"schema":{"type":"string","example":"24740,70408,21458"}},"statusParam":{"name":"status","in":"query","description":"A single appointment status to search for. This is an exact string match of either `TERMINATED` or `APPOINTED` - this will filter on the `status` field","required":false,"schema":{"type":"string","enum":["TERMINATED","APPOINTED"],"example":"TERMINATED"}},"activeParam":{"name":"active","in":"query","description":"`true` or `false` indicating a search for active licenses (in its absence, both active and inactive licenses will be returned)\n","required":false,"schema":{"type":"boolean","example":false}},"loaCodesParam":{"name":"loaCodes","in":"query","description":"comma separated list of LOA codes to filter licenses. This will return all licenses that match at least one of the specified LOA codes.","required":false,"schema":{"type":"string","example":"12,3"}},"licenseIdsParam":{"name":"licenseIds","in":"query","description":"comma separated list of license IDs","required":false,"schema":{"type":"string","example":"10000,1000033,21733"}},"licenseIdPathParam":{"name":"licenseId","in":"path","description":"License ID of the data to return","required":true,"schema":{"type":"integer","example":1234567}}},"responses":{"400BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1742929112},"status":{"type":"integer","example":400},"error":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"Invalid parameter values provided - {parameter}:[{invalid values}]"},"path":{"type":"string","example":"{endpoint_path}"}}}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized"}}}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1742935636},"status":{"type":"integer","example":403},"path":{"type":"string","example":"{requested endpoint}"},"error":{"type":"string","example":"Forbidden"}}}}}},"404NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1742929112},"status":{"type":"integer","example":404},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"Error message describing what was not found"},"path":{"type":"string","example":"{requested endpoint}"}}}}}},"405MethodNotAllowed":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"about:blank"},"status":{"type":"integer","example":405},"detail":{"type":"string","example":"Method 'PUT' is not supported."},"instance":{"type":"string","example":"{requested endpoint}"}}}}}},"429TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"API rate limit exceeded"}}}}}},"500InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"integer","example":1613510729601},"status":{"type":"integer","example":500},"error":{"type":"string","example":"Internal Server Error"},"message":{"type":"string","example":"Error message describing why this was a server error."},"path":{"type":"string","example":"{requested endpoint}"}}}}}},"504GatewayTimeout":{"description":"Gateway Timeout"}},"headers":{"ratelimit-limit":{"description":"Maximum number of requests allowed in the current window","schema":{"type":"integer"}},"ratelimit-remaining":{"description":"Number of requests remaining in the current window","schema":{"type":"integer"}},"ratelimit-reset":{"description":"Time when the rate limit will reset","schema":{"type":"integer"}}}}} ```