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 representation of a person resource. A person contains information identifying a subscriber or signatory (debtor).

Properties
honorificPrefix
The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
telephone
The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 16 characters or less, must start with a +, Read-Write.

2. signatory-representation

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

Properties
companyName
The signatory's company name. Constraints: Text, 70 characters or less, Read-Write.
organizationName
The signatory's organization name. Constraints: Text, 24 characters or less, Read-Write.
honorificPrefix
The honorific prefix of the person. Constraints: Text, set to Mr, Miss or 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 address of the person. Constraints: Text, 70 characters or less, Read-Write.
telephone
The telephone number of the person. Constraints: Text, an E.164 standard telephone number, 16 characters or less, must start with a +, Read-Write.

3. get-signatory (relation)

Description: Retrieve the representation of a signatory resource.

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: Retrieve a signatory representation
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.eyJzY29wZSI6WyJhcGkiXSwiZXhwIjoxNTMwNjMzNTk0LCJqdGkiOiI2ODNmNGE1Ni1kZjQ3LTQ0ZWYtYmIxYy02MDJhYmFlNGYwYjgiLCJjbGllbnRfaWQiOiJkZW1vY3JlZGl0b3IwMSJ9.VSmbmu4upmKj5_lTiBlqtbqSH42yx83AB1IFXJs08Tw
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": "john.doe@slimpay.com",
    "familyName": "Doe",
    "givenName": "John",
    "honorificPrefix": "Mr",
    "telephone": "+33655123841",
    "_links": {
        "self": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory"
        },
        "profile": {
            "href": "https://api.preprod.slimpay.com/alps/v1/signatories"
        },
        "https://api.slimpay.net/alps#get-bank-account": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/bank-account"
        },
        "https://api.slimpay.net/alps#get-billing-address": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557/signatory/billingAddress"
        },
        "https://api.slimpay.net/alps#get-mandate": {
            "href": "https://api.preprod.slimpay.com/mandates/6def0e61-7258-11e5-9eed-314e36732557"
        }
    }
}