> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cail.health/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cail.health/_mcp/server. # Update a provider verification PATCH https://staging.cail.health/v1/providers/{type}/{id}/verification Content-Type: application/json Transitions a provider resource into a new verification state. Reviewer-only. Audit-trail captured on the verification event log. Notes are operational free text and must not include patient identifiers, postcodes, or any PII. Reference: https://docs.cail.health/api-references/api-reference/curate-your-network/update ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: cail-api version: 1.0.0 paths: /v1/providers/{type}/{id}/verification: patch: operationId: update summary: Update a provider verification description: >- Transitions a provider resource into a new verification state. Reviewer-only. Audit-trail captured on the verification event log. Notes are operational free text and must not include patient identifiers, postcodes, or any PII. tags: - subpackage_curateYourNetwork parameters: - name: type in: path description: FHIR resource type the verification applies to. required: true schema: $ref: >- #/components/schemas/V1ProvidersTypeIdVerificationPatchParametersType - name: id in: path description: Stable identifier of the resource. required: true schema: type: string - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: The verified resource. content: application/json: schema: $ref: '#/components/schemas/UpdateVerificationResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProviderVerificationRequest' servers: - url: https://staging.cail.health description: https://staging.cail.health components: schemas: V1ProvidersTypeIdVerificationPatchParametersType: type: string enum: - Organization - Location - HealthcareService title: V1ProvidersTypeIdVerificationPatchParametersType UpdateProviderVerificationRequestStatus: type: string enum: - unverified - verified - rejected - needs_review description: Target verification status. title: UpdateProviderVerificationRequestStatus UpdateProviderVerificationRequest: type: object properties: status: $ref: '#/components/schemas/UpdateProviderVerificationRequestStatus' description: Target verification status. method: type: string description: >- Free-form code describing how the verification happened (e.g. `manual-review`, `documentary`). notes: type: string description: >- Operational notes recorded with the verification event. Free text only; must not include patient identifiers, postcodes, or any other PII. evidenceReference: type: string description: >- Optional pointer to supporting evidence (URL, document id, or external case reference). Storage is owned by reviewer tooling, not this API. required: - status title: UpdateProviderVerificationRequest VerifiedProviderViewResourceType: type: string enum: - Organization - Location - HealthcareService description: FHIR resource type the verification applies to. title: VerifiedProviderViewResourceType VerifiedProviderViewVerificationStatus: type: string enum: - unverified - verified - rejected - needs_review description: Current verification status. title: VerifiedProviderViewVerificationStatus VerifiedProviderViewVerifiedAt: type: object properties: {} description: >- ISO 8601 timestamp at which the row most recently entered a non-unverified state. title: VerifiedProviderViewVerifiedAt VerifiedProviderViewVerifiedByActorId: type: object properties: {} description: Stable identifier of the actor that recorded the verification. title: VerifiedProviderViewVerifiedByActorId VerifiedProviderViewVerificationMethod: type: object properties: {} description: Method used to verify. title: VerifiedProviderViewVerificationMethod VerifiedProviderViewVerificationNotes: type: object properties: {} description: Operational notes attached to the verification. title: VerifiedProviderViewVerificationNotes VerifiedProviderView: type: object properties: resourceType: $ref: '#/components/schemas/VerifiedProviderViewResourceType' description: FHIR resource type the verification applies to. resourceId: type: string description: Stable identifier of the verified resource. verificationStatus: $ref: '#/components/schemas/VerifiedProviderViewVerificationStatus' description: Current verification status. verifiedAt: oneOf: - $ref: '#/components/schemas/VerifiedProviderViewVerifiedAt' - type: 'null' description: >- ISO 8601 timestamp at which the row most recently entered a non-unverified state. verifiedByActorId: oneOf: - $ref: '#/components/schemas/VerifiedProviderViewVerifiedByActorId' - type: 'null' description: Stable identifier of the actor that recorded the verification. verificationMethod: oneOf: - $ref: '#/components/schemas/VerifiedProviderViewVerificationMethod' - type: 'null' description: Method used to verify. verificationNotes: oneOf: - $ref: '#/components/schemas/VerifiedProviderViewVerificationNotes' - type: 'null' description: Operational notes attached to the verification. required: - resourceType - resourceId - verificationStatus - verifiedAt - verifiedByActorId - verificationMethod - verificationNotes title: VerifiedProviderView UpdateVerificationResponse: type: object properties: data: $ref: '#/components/schemas/VerifiedProviderView' message: type: string description: Human-readable acknowledgement. required: - data - message title: UpdateVerificationResponse securitySchemes: auth0Bearer: type: http scheme: bearer ``` ## Examples **Request** ```json { "status": "verified" } ``` **Response** ```json { "data": { "resourceType": "Organization", "resourceId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "verificationStatus": "verified", "verifiedAt": "2026-05-13T14:21:00.000Z", "verifiedByActorId": "0c1d2e3f-4a5b-4677-8899-aabbccddeeff", "verificationMethod": "manual-review", "verificationNotes": null }, "message": "Verification updated" } ``` **SDK Code** ```python A provider verified by manual review import requests url = "https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification" payload = { "status": "verified" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript A provider verified by manual review const url = 'https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"status":"verified"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go A provider verified by manual review package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification" payload := strings.NewReader("{\n \"status\": \"verified\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby A provider verified by manual review require 'uri' require 'net/http' url = URI("https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"status\": \"verified\"\n}" response = http.request(request) puts response.read_body ``` ```java A provider verified by manual review import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"status\": \"verified\"\n}") .asString(); ``` ```php A provider verified by manual review request('PATCH', 'https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification', [ 'body' => '{ "status": "verified" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp A provider verified by manual review using RestSharp; var client = new RestClient("https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"status\": \"verified\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift A provider verified by manual review import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["status": "verified"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://staging.cail.health/v1/providers/Organization/f47ac10b-58cc-4372-a567-0e02b2c3d479/verification")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```