Yedpay

Description (Credential's Document)

Show all document which relate to the selected Credential. (GET)

End Point

https://api.yedpay.com/v1/credentials/{{credential_id}}/documents

Variable

# Name Type Description
1 credential_id String Credential's ID

Request Header

# Key Value Description
1 Authorization Bearer {{access_token}} Login Token

Body

# Name Type Description

Response

# Name Type Description
1 success String Show Credential's document Success or Fail
2 data Array Include all document's information which relate to the selected Credential. (id, name, etc..)

Success Response - data

# Name Type Description
1 id String Id of the Document
2 user_id String Id of the User
3 type String Type of the Document
4 name String Name of the Document
5 description String Description of the Document
6 mime String Type of the Image
7 size Integer Size of the Document
8 shared String Whether the Document is Shared or Not

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "qQvy0rl3",
                        "user_id": "JwoMPpKy",
                        "type": "private_key",
                        "name": "xxx.jpeg",
                        "description": "xxx",
                        "mime": "image/jpeg",
                        "size": 6800,
                        "shared": false
                    }
                ]
            }
        

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }
        

v1.28.0-20190905 © The Payment Cards Group Limited. All rights reserved.