Create new users. - Apipagos v2

Request

Authorization

Add parameter in header

Company-Token

Example:

Company-Token: ********************

Header Params

Accept

string

optional

Example:

application/json

Body Params application/json

array of:

type

enum<string>

write-onlyrequired

Allowed values:

fj

email

string <email>

required

first_name

string

required

last_name

string

required

field_1

string

required

Match pattern:

^[0-9]{6}$

field_2

string

required

Match pattern:

^[0-9]{4}$

field_3

string

required

Match pattern:

^(20|23|24|25|26|27|30)[0-9]{8}[0-9]

password

string

required

profile_photo_url

string

required

birthdate

string

required

birth_country

string

required

nationality

string

required

gender

enum<string>

write-onlyrequired

Allowed values:

MaleFemaleOther

marital_status

enum<string>

write-onlyrequired

Allowed values:

SingleMarriedDivorcedWidowedOther

status_code

enum<integer> <int32>

write-onlyrequired

>= 0

Allowed values:

01

Default:

0

extras

array [object {3}]

required

name

string

required

key_code

string

required

value

string

required

Example

[
    {
        "birth_country": "ARG",
        "birthdate": "1985-05-30",
        "email": "[email protected]",
        "field_1": "4568",
        "field_2": "444",
        "field_3": "20294687914",
        "first_name": "Asc",
        "gender": "Male",
        "last_name": "Koelza",
        "marital_status": "Single",
        "nationality": "ARG",
        "status_code": "1",
        "type": "j",
        "password": null,
        "extras": [
            {
                "name": "Extra Key 1",
                "key_code": "key_1",
                "value": "cupidatat"
            },
            {
                "name": "Extra Key 2",
                "key_code": "key_2",
                "value": "incididunt"
            }
        ]
    },
    {
        "birth_country": "AR",
        "birthdate": "1981-05-17",
        "email": "[email protected]",
        "field_1": "4568",
        "field_2": "444",
        "field_3": "27254687917",
        "first_name": "Aa",
        "gender": "Female",
        "last_name": "Koelza",
        "marital_status": "Divorced",
        "nationality": "ARG",
        "status_code": "1",
        "type": "j",
        "password": null,
        "extras": [
            {
                "name": "Extra Key 1",
                "key_code": "key_1",
                "value": "cupidatat"
            },
            {
                "name": "Extra Key 2",
                "key_code": "key_2",
                "value": "incididunt"
            }
        ]
    }
]

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.test.apipagos.com/api/v2/apipagos/users' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '[
    {
        "birth_country": "ARG",
        "birthdate": "1985-05-30",
        "email": "[email protected]",
        "field_1": "4568",
        "field_2": "444",
        "field_3": "20294687914",
        "first_name": "Asc",
        "gender": "Male",
        "last_name": "Koelza",
        "marital_status": "Single",
        "nationality": "ARG",
        "status_code": "1",
        "type": "j",
        "password": null,
        "extras": [
            {
                "name": "Extra Key 1",
                "key_code": "key_1",
                "value": "cupidatat"
            },
            {
                "name": "Extra Key 2",
                "key_code": "key_2",
                "value": "incididunt"
            }
        ]
    },
    {
        "birth_country": "AR",
        "birthdate": "1981-05-17",
        "email": "[email protected]",
        "field_1": "4568",
        "field_2": "444",
        "field_3": "27254687917",
        "first_name": "Aa",
        "gender": "Female",
        "last_name": "Koelza",
        "marital_status": "Divorced",
        "nationality": "ARG",
        "status_code": "1",
        "type": "j",
        "password": null,
        "extras": [
            {
                "name": "Extra Key 1",
                "key_code": "key_1",
                "value": "cupidatat"
            },
            {
                "name": "Extra Key 2",
                "key_code": "key_2",
                "value": "incididunt"
            }
        ]
    }
]'

Responses

🟢200OK

application/json

Body

data

array [object {29}]

required

id

integer <int64>

optional

code

string

optional

Match pattern:

^[a-f0-9]{32}$

type

enum<string>

optional

Allowed values:

fj

email

string

optional

email_verified_at

null

optional

first_name

string

optional

last_name

string

optional

field_1

string

optional

Match pattern:

^[0-9]{6}$

field_2

string

optional

Match pattern:

^[0-9]{4}$

field_3

string

optional

Match pattern:

^(20|23|24|25|26|27|30)[0-9]{8}[0-9]

profile_photo_url

null

optional

birthdate

string <date>

optional

birth_country

string

optional

nationality

string

optional

gender

enum<string>

optional

Allowed values:

MaleFemaleOther

marital_status

enum<string>

optional

Allowed values:

SingleMarriedDivorcedWidowedOther

created_at

string

optional

updated_at

string

optional

addresses

array[string]

optional

identities

array[string]

optional

contactInfo

array[string]

optional

paymentMethods

array[string]

optional

accounts

array[string]

optional

fiscalData

null

optional

validations

array[string]

optional

extras

array [object {6}]

optional

company

object

optional

relations

array[string]

optional

complianceExtra

array[string]

optional

Example

{
    "data": [
        {
            "id": 72,
            "code": "e0a1dcf01f8ca43d56d3991170f3aaec",
            "type": "f",
            "email": "[email protected]",
            "email_verified_at": null,
            "first_name": "Emilio",
            "last_name": "Negrete",
            "field_1": "veniam minim",
            "field_2": "labore deserunt",
            "field_3": "exercitation",
            "profile_photo_url": null,
            "birthdate": "1970-07-01",
            "birth_country": "Argentina",
            "nationality": "Argentina",
            "gender": "Male",
            "marital_status": "Married",
            "created_at": "2024-08-14T13:41:36.737Z",
            "updated_at": "2024-08-13T23:04:40.921Z",
            "addresses": [],
            "identities": [],
            "contactInfo": [],
            "paymentMethods": [],
            "accounts": [],
            "fiscalData": null,
            "validations": [],
            "extras": [
                {
                    "name": "Extra Key",
                    "key_code": "extra_key",
                    "value": "occaecat nulla enim mollit",
                    "created_at": "2024-08-13T23:51:24.644Z",
                    "updated_at": "2024-08-13T23:07:25.601Z",
                    "deleted_at": null
                }
            ],
            "company": {
                "company": "enim id",
                "name": "vero optio aspernatur",
                "legal_name": "ratione quos dolorum",
                "tax_id": "dolore elit",
                "email": "[email protected]",
                "website": "https://itchy-fight.com",
                "status_code": 17400384,
                "logo": "culpa",
                "portal_link": "https://shiny-vagrant.com",
                "validity_date": "2024-08-13T22:16:09.982Z",
                "auditor": "quis ad ullamco",
                "end_date": null,
                "deleted_at": null,
                "updated_at": "2024-08-13T16:42:10.057Z",
                "created_at": "2024-08-13T19:54:54.888Z"
            },
            "relations": [],
            "complianceExtra": []
        }
    ],
    "links": {
        "first": "nulla magna incididunt",
        "last": "consectetur mollit in",
        "next": "sint ut",
        "prev": "cupidatat"
    },
    "message": "Ipsum libero debitis porro. Officiis explicabo reprehenderit commodi. Iste architecto atque.",
    "meta": {
        "current_page": "ex Duis commodo",
        "from": "dolore sed id deserunt laboris",
        "last_page": "reprehenderit pariatur irure eu",
        "links": [
            {
                "active": "ea proident in magna incididunt",
                "label": "deserunt qui",
                "url": "http://opulent-executor.org"
            }
        ],
        "path": "elit",
        "per_page": "aliquip anim dolor irure dolore",
        "to": "ut",
        "total": "est reprehenderit ea minim veniam"
    }
}