Validate PP

POST 
/validate/pp/:id

Create a validation entry for PP

Request

Path Parameters

id uuidrequired

Account ID

Header Parameters

sub-account stringrequired

Sub-account identifier required for all requests

application/json

Body

required

first_name stringrequired

First name of the person.

last_name stringrequired

Last name of the person.

birth_date stringrequired

Birth date of the person.

birth_city stringrequired

Birth city of the person.

birth_country stringrequired

Birth country of the person.

Responses

201

Validation created

application/json

Schema

Schema

account

object

required

account_id uuidrequired

Unique identifier for the account.

account_last_modified stringrequired

Timestamp for the account creation.

account_national_id stringrequired

Siret number of the account.

account_name stringrequired

Name of the account. Defined by the SIRET number.

account_type stringrequired

Possible values: [personneMorale, personnePhysique]

Type of the account.

account_is_active booleanrequired

Status of the account. For more infos see /validate

account_deletion_date stringrequired

Timestamp for the account deletion.

account_created_at stringrequired

Timestamp for the account creation.

account_currency stringrequired

Currency of the account. Only EUR supported for now.

account_notification_email stringrequired

Notification email for the account, will get notified for each successful payment.

account_creation_url stringrequired

URL for account activation. For more infos see /validate

account_blob_storage_url stringrequired

URl for blob storage. For more infos see /validate/pm

partner_id uuidrequired

Partner id of the account.

creator_id uuidrequired

ID of the creator of the account

user

object

required

user_id stringrequired

Unique identifier of the user

user_last_modified date-time

Time when the user profile was last modified

user_first_name string

First name of the user

user_last_name string

Last name of the user

user_birth_date date

Birth date of the user

user_birth_city string

Birth city of the user

user_birth_country string

Birth country of the user

user_phone string

Phone number of the user

user_email stringrequired

Email address of the user

user_role stringrequired

Possible values: [admin, user]

Role of the user

creator_id stringrequired

Identifier of the user who created this user profile

Example (from schema)

{
  "account": {
    "account_id": "efc21e45-79d1-48d8-ac19-ea0ecaef2bc5",
    "account_last_modified": "2021-09-01T09:00:00Z",
    "account_national_id": "12345678901234",
    "account_name": "FORTAINE SOFTWARE",
    "account_type": "personneMorale",
    "account_is_active": true,
    "account_deletion_date": "2021-09-01T09:00:00Z",
    "account_created_at": "2021-09-01T09:00:00Z",
    "account_currency": "EUR",
    "account_notification_email": "louka.altdorf-reynes@ribpay.app",
    "account_creation_url": "http://localhost:3001/account/TestKey1/efc21e45-79d1-48d8-ac19-ea0ecaef2bc5",
    "account_blob_storage_url": "http://localhost:3001/account/TestKey1/efc21e45-79d1-48d8-ac19-ea0ecaef2bc5",
    "partner_id": "partner_id",
    "creator_id": "TestKey1"
  },
  "user": {
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_last_modified": "2024-04-25T10:00:00Z",
    "user_first_name": "John",
    "user_last_name": "Doe",
    "user_birth_date": "1990-04-25",
    "user_birth_city": "New York",
    "user_birth_country": "USA",
    "user_phone": "+1234567890",
    "user_email": "user@example.com",
    "user_role": "admin",
    "creator_id": "Admin"
  }
}

Loading...