{ "opencollection": "1.0.0", "info": { "name": "Appealable Issues Supplemental Claims API", "version": "v0" }, "items": [ { "info": { "name": "Supplemental Claims", "type": "folder" }, "items": [ { "info": { "name": "Creates a new Supplemental Claim", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/supplemental_claims", "headers": [ { "name": "X-VA-SSN", "value": "706547821" }, { "name": "X-VA-ICN", "value": "1013062086V794840" }, { "name": "X-VA-First-Name", "value": "Cara" }, { "name": "X-VA-Middle-Initial", "value": "" }, { "name": "X-VA-Last-Name", "value": "Bartlett" }, { "name": "X-VA-Birth-Date", "value": "1975-02-14" }, { "name": "X-VA-File-Number", "value": "" }, { "name": "X-VA-NonVeteranClaimant-First-Name", "value": "" }, { "name": "X-VA-NonVeteranClaimant-Middle-Initial", "value": "" }, { "name": "X-VA-NonVeteranClaimant-Last-Name", "value": "" }, { "name": "X-Consumer-Username", "value": "" }, { "name": "X-Consumer-ID", "value": "" }, { "name": "X-Alternate-Signer-First-Name", "value": "" }, { "name": "X-Alternate-Signer-Middle-Initial", "value": "" }, { "name": "X-Alternate-Signer-Last-Name", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits an appeal of type Supplemental Claim. This endpoint is the same as submitting [VA form 200995](https://www.vba.va.gov/pubs/forms/VBA-20-0995-ARE.pdf) via mail or fax directly to the Board of Veterans’ Appeals.\n

\nNote about the 5103 Notice of Acknowledgement\n

\nThe 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: [http://www.va.gov/disability/ho" }, { "info": { "name": "Shows a specific Supplemental Claim. (a.k.a. the Show endpoint)", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/supplemental_claims/:uuid", "params": [ { "name": "uuid", "value": "7efd87fc-fac1-4851-a4dd-b9aa2533f57f", "type": "path", "description": "Supplemental Claim UUID" } ] }, "docs": "Returns all of the data associated with a specific Supplemental Claim." }, { "info": { "name": "Gets the Supplemental Claims JSON Schema.", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/supplemental_claims/schema" }, "docs": "Returns the [JSON Schema](https://json-schema.org/) for the `POST /supplemental_claims` endpoint." }, { "info": { "name": "Validates a POST request body against the JSON schema.", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/supplemental_claims/validate", "headers": [ { "name": "X-VA-SSN", "value": "706547821" }, { "name": "X-VA-ICN", "value": "1013062086V794840" }, { "name": "X-VA-First-Name", "value": "Cara" }, { "name": "X-VA-Middle-Initial", "value": "" }, { "name": "X-VA-Last-Name", "value": "Bartlett" }, { "name": "X-VA-Birth-Date", "value": "1975-02-14" }, { "name": "X-VA-File-Number", "value": "" }, { "name": "X-VA-Insurance-Policy-Number", "value": "" }, { "name": "X-VA-NonVeteranClaimant-First-Name", "value": "" }, { "name": "X-VA-NonVeteranClaimant-Last-Name", "value": "" }, { "name": "X-Consumer-Username", "value": "" }, { "name": "X-Consumer-ID", "value": "" }, { "name": "X-Alternate-Signer-First-Name", "value": "" }, { "name": "X-Alternate-Signer-Middle-Initial", "value": "" }, { "name": "X-Alternate-Signer-Last-Name", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Like the POST /supplemental_claims, but only does the validations —does not submit anything." }, { "info": { "name": "Get a location for subsequent evidence submission document upload PUT request", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/supplemental_claims/evidence_submissions", "headers": [ { "name": "X-VA-SSN", "value": "706547821" } ], "params": [ { "name": "sc_uuid", "value": "7efd87fc-fac1-4851-a4dd-b9aa2533f57f", "type": "query", "description": "Associated Supplemental Claim UUID" } ] }, "docs": "This is the first step to submitting supporting evidence for a Supplemental Claim. (See the Evidence Uploads section above for additional information.)\nThe Supplemental Claim GUID that is returned when the SC is submitted, is supplied to this endpoint to ensure the SC is in a valid state for sending supporting evidence documents.\n\nEvidence may be uploaded up to 7 days from the 'created_at' date of the associated Supplemental Claim via 'supplemental_claims/evidence_submissions'.\n" }, { "info": { "name": "Accepts Supplemental Claim Evidence Submission document upload.", "type": "http" }, "http": { "method": "PUT", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/sc_upload_path", "headers": [ { "name": "Content-MD5", "value": "" } ] }, "docs": "Accepts document metadata, document binary, and attachment binaries. Full URL, including\nquery parameters, provided from POST `/*/evidence_submissions`.\nPlease see the `documentUploadMetadata` schema for the required payload schema.\n\n## Example Payload\n\nThe following demonstrates a (redacted) multipart payload suitable for submitting to the PUT\nendpoint. Most programming languages should have provisions for assembling a multipart\npayload like this without having to do so manually.\n\n```\n--17de1ed" }, { "info": { "name": "Returns all of the data associated with a specific Supplemental Claim Evidence Submission.", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/supplemental_claims/evidence_submissions/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "Supplemental Claim UUID Evidence Submission" } ] }, "docs": "Returns all of the data associated with a specific Supplemental Claim Evidence Submission." }, { "info": { "name": "Creates a new Supplemental Claim", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/forms/200995", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Submits an appeal of type Supplemental Claim. This endpoint is the same as submitting [VA form 200995](https://www.vba.va.gov/pubs/forms/VBA-20-0995-ARE.pdf) via mail or fax directly to the Board of Veterans’ Appeals.\n

\nNote about the 5103 Notice of Acknowledgement\n

\nThe 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: [http://www.va.gov/disability/ho" }, { "info": { "name": "Show a specific Supplemental Claim", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/forms/200995/:id", "params": [ { "name": "id", "value": "7efd87fc-fac1-4851-a4dd-b9aa2533f57f", "type": "path", "description": "Supplemental Claim UUID" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns basic data associated with a specific Supplemental Claim." }, { "info": { "name": "Download a watermarked copy of a submitted Supplemental Claim", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/forms/200995/:id/download", "params": [ { "name": "icn", "value": "1012832025V743496", "type": "query", "description": "ICN of the Veteran associated with the Supplemental Claim. Optional when using a veteran-scoped OAuth token. Required when using a representative- or system-scoped token." }, { "name": "id", "value": "44444444-5555-6666-7777-888888888888", "type": "path", "description": "Supplemental Claim ID" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a watermarked copy of a Supplemental Claim PDF as submitted to the VA. PDFs are available\nwith the following caveats:\n\n1. The PDF download will become available only after after the Supplemental Claim has progressed to\n the 'submitted' state.\n2. The PDF will stop being available one week after the Supplemental Claim has progressed to the\n 'completed' state. This is when the Veteran's personally identifying information is purged from our servers.\n\nThe 'icn' parameter is required when " }, { "info": { "name": "Gets the Supplemental Claims JSON Schema.", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/schemas/:schema_type", "params": [ { "name": "schema_type", "value": "", "type": "path", "description": "Schema type. Can be: `200995`, `address`, `nonBlankString`, `phone`, `timezone`" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the [JSON Schema](https://json-schema.org/) for the `POST /forms/200995` endpoint." }, { "info": { "name": "Validates a POST request body against the JSON schema.", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/forms/200995/validate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Like the POST /supplemental_claims, but only does the validations —does not submit anything." }, { "info": { "name": "Get a location for subsequent evidence submission document upload PUT request", "type": "http" }, "http": { "method": "POST", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/evidence-submissions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is the first step to submitting supporting evidence for a Supplemental Claim. (See the Evidence Uploads section above for additional information.)\nThe Supplemental Claim GUID that is returned when the SC is submitted, is supplied to this endpoint to ensure the SC is in a valid state for sending supporting evidence documents.\n\nEvidence may be uploaded up to 7 days from the 'created_at' date of the associated Supplemental Claim via 'supplemental_claims/evidence_submissions'.\n" }, { "info": { "name": "Accepts Supplemental Claim Evidence Submission document upload.", "type": "http" }, "http": { "method": "PUT", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/sc-upload-path", "headers": [ { "name": "Content-MD5", "value": "" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Accepts document metadata, document binary, and attachment binaries. Full URL, including\nquery parameters, provided from POST `/*/evidence-submissions`.\nPlease see the `documentUploadMetadata` schema for the required payload schema.\n\n## Example Payload\n\nThe following demonstrates a (redacted) multipart payload suitable for submitting to the PUT\nendpoint. Most programming languages should have provisions for assembling a multipart\npayload like this without having to do so manually.\n\n```\n--17de1ed" }, { "info": { "name": "Returns all of the data associated with a specific Supplemental Claim Evidence Submission.", "type": "http" }, "http": { "method": "GET", "url": "https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}/evidence-submissions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Supplemental Claim UUID Evidence Submission" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all of the data associated with a specific Supplemental Claim Evidence Submission." } ] } ], "bundled": true }