production
https://api.availity.com/availity
Custom API Endpoint
Paths
/dfs/{id}
get /dfs/{id}
Download a stored file using an encrypted URL.
oauth2
oauth2
(oauth2 application)
Token URL
https://api.availity.com/v1/token
Scopes
hipaa
Realtime - Live HIPAA API
id
Required in path
string
The ecrypted file identifier
Accept
Optional in header
string
application/json
application/xml
application/octet-stream
application/xml
application/octet-stream
200
OK
400
Bad Request
401
Not Authorized
403
Forbidden
500
Internal Server Error
Example Request
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
Definitions
{
"type": "object",
"properties": {
"userMessage": {
"type": "string",
"description": "A high level error message."
},
"developerMessage": {
"type": "string",
"description": "A more technical error message."
},
"reasonCode": {
"type": "integer",
"description": "A reason code."
},
"statusCode": {
"type": "integer",
"description": "The status code."
},
"errors": {
"type": "array",
"description": "A list of detailed user friendly messages.",
"items": {
"$ref": "#/definitions/FieldError"
}
}
}
}
{
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The field or parameter associated with this error."
},
"code": {
"type": "string",
"description": "A code for the error."
},
"errorMessage": {
"type": "string",
"description": "The message associated with this error."
},
"index": {
"type": "integer",
"description": "The array index of the item associated with this error."
}
}
}