Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

signatories

  1. person-representation
  2. signatory-representation
  3. get-signatory

1. person-representation

Description: A person representation. A person contains identification information.

Properties
honorificPrefix
The honorific prefix of the person. Constraints: Text among Mr|Miss|Mrs, Read-Write.
familyName
The family name of the person. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write.
givenName
The given name of the person. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write.
email
The email of the person. Constraints: Text, 70 characters or less, Read-Write.
telephone
The telephone of the person. Constraints: Text, 16 characters or less, must start with a +, Read-Write.

2. signatory-representation

Description: A signatory representation. A signatory is a person who signs a document or a mandate. A signatory is primarily related to a mandate, a bank account and a billing address.

Properties
companyName
The company name. Constraints: Text, 70 characters or less, Read-Write.
organizationName
An organization name. Constraints: Text, 24 characters or less, Read-Write.
honorificPrefix
The honorific prefix of the person. Constraints: Text among Mr|Miss|Mrs, Read-Write.
familyName
The family name of the person. Also known as lastName. Constraints: Text, 70 characters or less, Read-Write.
givenName
The given name of the person. Also known as firstName. Constraints: Text, 32 characters or less, Read-Write.
email
The email of the person. Constraints: Text, 70 characters or less, Read-Write.
telephone
The telephone of the person. Constraints: Text, 16 characters or less, must start with a +, Read-Write.

3. get-signatory (relation)

Description: Get one signatory.

Properties

No dynamic property needed. This usually means that the server already took the liberty to build the full URL for you depending on the context. Less code for you!

Example: Get one signatory
Request
GET follow(https://api.slimpay.net/alps#get-signatory) HTTP/1.1
Accept: application/hal+json; profile="https://api.slimpay.net/alps/v1"
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNDg4NDc0NzI1LCJqdGkiOiI3OThhNGEyYy1hOGE4LTQwNmItOGY0YS1mMjE3ZmNhMTM5YjciLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VoN5FoWOoPfLkJU15ZIcYp2iRam4WJoVfMBw_35XCkw
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json; profile="https://api.slimpay.net/alps/v1";charset=UTF-8
Content-Length: 912

{
    "email": "rodolphe.rocca@slimpay.com",
    "familyName": "Doe",
    "givenName": "John",
    "honorificPrefix": "Mr",
    "telephone": "+33655123841",
    "_links": {
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557"
        },
        "https://api.slimpay.net/alps#get-bank-account": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/bank-account"
        },
        "self": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory"
        },
        "https://api.slimpay.net/alps#get-billing-address": {
            "href": "https://api-sandbox.slimpay.net/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/billingAddress"
        },
        "profile": {
            "href": "https://api-sandbox.slimpay.net/alps/v1/signatories"
        }
    }
}