Download OpenAPI specification:Download
Merchants related endpoints
Check if a user exists
Email of the user to check existence
Phone number of the user to check existence
Identifier of the caller for rate limiting purposes (for example, the browser IP address or any unique identifier). If not provided, rate limiting will block requests only based on the clientId, which may lead to blocking legitimate requests from the same client. Providing a caller_id allows for more granular rate limiting and helps prevent blocking legitimate requests.
Successful operation
Bad request
Unauthorized
Too many requests
{"exists": true,"token_count": 2}
Create a user and its consent
Merchant identifier
Merchant customer reference
User application
Forbidden (eg: Unsupported Origin)
Merchant was not found
{"customer_reference": "customer_12345","user": {"email": "[email protected]","phone_number": "+33612345678","first_name": "John","last_name": "Doe","gender": "male","birthdate": "1990-01-15","addresses": [{"address_type": "billing","street_address": "123 Main Street","address_complement": "Apt 4B","locality": "Paris","postal_code": "75001","country": "FRANCE"}]}}
Start passwordless authentication on specified phone number or email address
Phone number
Email address
Identifier of the caller for rate limiting purposes (for example, the browser IP address or any unique identifier. If not provided, rate limiting will block requests only based on the clientId, which may lead to blocking legitimate requests from the same client. Providing a callerId allows for more granular rate limiting and helps prevent blocking legitimate requests.
Passwordless authentication unavailable
{"phone_number": "+33623456789"}
{"type": "https://api.purse.eu/problems/validation-error","title": "Validation Error","status": 400,"detail": "The request body contains invalid fields.","instance": "/v1/merchants/123e4567-e89b-12d3-a456-426614174000/users","error": "Invalid email format","errors": [{"detail": "must be a valid email address","pointer": "/user/email"}]}
Verify passwordless authentication on specified phone number or email address
Verification code
Identifier of the caller for rate limiting purposes (for example, the browser IP address or any unique identifier). If not provided, rate limiting will block requests only based on the clientId, which may lead to blocking legitimate requests from the same client. Providing a callerId allows for more granular rate limiting and helps prevent blocking legitimate requests.
{"phone_number": "+33623456789","verification_code": "123456"}
{"consent_challenge_id": "ae900e3c-91df-4e71-ba49-60985827c258","user": {"email": "[email protected]","phone_number": "+331234567890","first_name": "John","last_name": "Doe","gender": "male","birthdate": "1990-01-01","addresses": [{"address_type": "billing","street_address": "123 Main St","address_complement": "Apt 4B","locality": "Paris","postal_code": "75001","country": "FRANCE"}]}}
Create a consent for a user and its merchant using consent challenge
Consent challenge identifier
Merchant or challenge was not found
{"consent_challenge_id": "bdc87c71-3a82-4757-91b2-559b1a888766"}
Retrieve user information based on merchant customer reference
Forbidden
Not found
{"email": "[email protected]","phone_number": "+33612345678","first_name": "John","last_name": "Doe","gender": "male","birthdate": "1990-01-15","addresses": [{"address_type": "billing","street_address": "123 Main Street","address_complement": "Apt 4B","locality": "Paris","postal_code": "75001","country": "FRANCE"}]}