---
title: "Retrieve signature instruction"
method: GET
path: "/signature-instructions/{signatureInstructionId}"
tags: ["signatureInstructions"]
---

# Retrieve signature instruction

`GET /signature-instructions/{signatureInstructionId}`

## Request

- Base URL: `https://api.payroc.com/v1`
- URL: `https://api.payroc.com/v1/signature-instructions/{signatureInstructionId}`
- Auth: HTTP bearer

Use this method to retrieve information about a signature instruction.  

To retrieve a signature instruction, you need its signatureInstructionId. Our gateway returned the signatureInstructionId in the response of the [Submit Signature Instruction](https://docs.payroc.com/api/schema/payroc-cloud/signature-instructions/submit) method.  

Our gateway returns the status of the instruction. If the payment device completed the instruction, the response also includes a link to retrieve the signature.

## Path parameters

- `signatureInstructionId` string, required

## Response `200`

Successful request. Returns the signature instruction.

- SignatureInstruction
  - `status` 'canceled' | 'completed' | 'failure' | 'inProgress', required: Indicates the current status of the instruction. - `canceled` – The instruction was canceled before it was completed. - `completed` – The instruction has completed. Use the link object to check the resource. - `failure` – The instruction failed. Check the errorMessage field for more information. - `inProgress` – The instruction is currently in progress.
  - `errorMessage` string: Description of the error that caused the instruction to fail. **Note:** We return this field only if the status is `failure`.
  - `link` Link: Object that contains HATEOAS links for the resource.
    - `rel` string, required: Indicates the relationship between the current resource and the target resource.
    - `method` string, required: HTTP method that you need to use with the target resource.
    - `href` string, required: URL of the target resource.
  - `signatureInstructionId` string, required: Unique identifier that our gateway assigned to the instruction.

## Other responses

- `400`: Invalid request
- `401`: Identity could not be verified
- `403`: Do not have permissions to perform this action
- `404`: Resource not found
- `406`: Not acceptable
- `500`: An error has occured

## Changes

- **2026-09-17** `9fc1e1d5b4a8`: 1 warning, 1 info
  - deleted the `header` request parameter `Authorization`
  - the endpoint scheme security `Bearer` was added to the API
- **2026-09-12** `9af893904873`: 1 info
  - api operation id `retrieve` removed and replaced with `signatureInstructions_retrieve`

[Operation history](https://skmtc.dev/payroc/apis/schema/changes/signature-instructions/:signatureInstructionId/get.md)

---

[API](https://skmtc.dev/payroc/apis/schema.md) - [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) - [OpenAPI document](https://skmtc.dev/payroc/apis/schema/revisions/735467f6d8cd?raw)
