Get Attachment

1 curl https://api.frankie.one/v2.1/organizations/entityId/documents/documentId/attachments/attachmentId \ 2 -H "api_key: <apiKey>" \ 3 -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012"

1 { 2 "requestId": "foo", 3 "attachment": { 4 "data": { 5 "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg" 6 }, 7 "attachmentId": "foo", 8 "sourceId": "foo", 9 "createdAt": "foo", 10 "updatedAt": "foo", 11 "filename": "foo", 12 "mimeType": "foo", 13 "pageNumber": 42, 14 "side": "FRONT", 15 "type": "foo", 16 "location": "foo", 17 "lastMalwareScanAt": "foo", 18 "retrievalStatus": "NORMAL" 19 }, 20 "informationSource": { 21 "sourceId": "foo", 22 "source": "Client", 23 "description": "", 24 "provider": "equifax-au", 25 "providerReference": "", 26 "createdAt": "2024-01-15T02:18:11.365Z", 27 "requestedAt": "2024-01-15T02:18:11.365Z", 28 "generatedAt": "2024-01-15T02:18:11.365Z", 29 "retrievedAt": "2024-01-15T02:18:11.365Z", 30 "updatedAt": "2024-01-15T02:18:11.365Z", 31 "isAuthoritative": false, 32 "type": "ID number", 33 "isManual": true 34 } 35 }

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

documentIdstringRequired

Unique identifier for a document

attachmentIdstringRequired

Query parameters

formatenumOptional

Enum of the attachment format - [NONE, BASE64, RAW]

Allowed values:

Response

OK - depending on request attachment format the type of content is returned, if raw is requested different file types are expected

requestIdstring or null

attachmentobject or null

informationSourceobject or null

Path parameters

Headers

Query parameters

Response

Errors