Retrieve attachment | Payroc

Use this method to retrieve the details of an attachment. To retrieve the details of an attachment you need its attachmentId. Our gateway returned the attachmentId in the response of the method that you used to upload the attachment. Our gateway returns information about the attachment, including its upload status and the entity that the attachment is linked to. Our gateway doesn't return the file that you uploaded.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

attachmentIdstringRequired

Unique identifier of the attachment

Response

Successful request. Returns the attachment.

attachmentIdstring

Unique identifier that our gateway assigned to the attachment.

typeenum

Type of attachment.

uploadStatusenum

Upload status of the attachment. The value is one of the following:

pending - We have not yet uploaded the attachment.
accepted - We have uploaded the attachment.
rejected - We rejected the attachment.

Upload status of the attachment. The value is one of the following: - `pending` - We have not yet uploaded the attachment. - `accepted` - We have uploaded the attachment. - `rejected` - We rejected the attachment.

Allowed values:

fileNamestring<=150 characters

Name of the file.

contentTypestring<=76 characters

Content type of the file.

entityobject

Object that contains information about the entity that the attachment is linked to.

createdDatedatetime

Date and time that we received your request to upload the attachment.

lastModifiedDatedatetime

Date and time the attachment was last modified.

descriptionstring or null<=250 characters

Short description of the attachment.

metadatamap from strings to strings or null

Object that you can send to include custom metadata in the request.

1	var client = new RestClient("https://api.payroc.com/v1/attachments/12876");
2	var request = new RestRequest(Method.GET);
3	request.AddHeader("Authorization", "Bearer <token>");
4	IRestResponse response = client.Execute(request);

1	{
2	"attachmentId": "15387",
3	"type": "personalIdentification",
4	"uploadStatus": "accepted",
5	"fileName": "oliviaDoePassport.pdf",
6	"contentType": "application/pdf",
7	"entity": {
8	"type": "processingAccount",
9	"id": "2585"
10	},
11	"createdDate": "2025-09-18T10:19:18.522Z",
12	"lastModifiedDate": "2025-09-18T10:19:18.522Z",
13	"description": "Passport for Olivia Doe",
14	"metadata": {
15	"passportId": "123456789"
16	}
17	}

Authentication

Path parameters

Response

Errors