Version: 1.0.0

Read an ongoing signup session

GET /signup/v1/session

Responses

Signup session reasponse

application/json

Schema
Example (from schema)

Schema

createddate string
Timestamp of when the registration started
locale string
country string
sessionid string
snippet string
the snippet to be presented in your frontend
extraCompanyFields object
Record of custom parameters that Briqpay will share on completed sessions - Contact Briqpay for complete specifications
property name* string
merchanturls object
terms string
signupwebhook string
The url where Briqpay should post data for you to validate the registration
redirecturl string
The page where Briqpay should redirect the customer after a successful registration
state string
merchantid string
Your merchant ID in briqpays system
merchantname string
Your merchant Name in briqpays system
cin string
The Company Identification Number of the registration-company
address object
companyname string
streetaddress string
zip string
city string
hq boolean
Wheter or not the selected address is the registered HQ of the company
user object
firstName string
lastName string
phone string
email string
validationFlow string

{
  "createddate": "",
  "locale": "en-gb",
  "country": "SE",
  "sessionid": "a1fe4580-5caf-11eb-b04a-ed52879a6427",
  "snippet": "<script>......</script>",
  "extraCompanyFields": {},
  "merchanturls": {
    "terms": "https://example.com/ToC",
    "signupwebhook": "https://example.com/signup-hook-handler",
    "redirecturl": "https://example.com/registration-completed"
  },
  "state": "string",
  "merchantid": "string",
  "merchantname": "string",
  "cin": "5505041844",
  "address": {
    "companyname": "string",
    "streetaddress": "Kingstreet 1 B",
    "zip": "24224",
    "city": "Kingcity",
    "hq": true
  },
  "user": {
    "firstName": "",
    "lastName": "",
    "phone": "",
    "email": ""
  },
  "validationFlow": ""
}