Users

POST /users

Crear nuevo Usuario

Petición de ejemplo:

POST /users HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "firstName": "string",
    "lastName": "string",
    "birthdate": "2024-10-14",
    "sex": "male",
    "civilStatus": "single",
    "nationality": "string",
    "legalInformation": {
        "taxIdType": "cuil",
        "taxId": "string",
        "taxCondition": "vatRegistered",
        "category": "consumidorFinal",
        "taxExempt": true
    },
    "legalAddress": {
        "streetName": "string",
        "streetNumber": "string",
        "floor": "string",
        "apartment": "string",
        "zipCode": "string",
        "neighborhood": "string",
        "city": "string",
        "region": "string",
        "country": "string"
    }
}

• Status Codes:

  • 201 Created –

    User created success

    Ejemplo de respuesta:

    HTTP/1.1 201 Created
    Content-Type: application/json
    
    {
        "uuid": "string",
        "firstName": "string",
        "lastName": "string",
        "birthday": "2024-10-14",
        "civilStatus": "single",
        "legalAddress": {
            "streetName": "string",
            "streetNumber": "string",
            "floor": "string",
            "apartment": "string",
            "zipCode": "string",
            "neighborhood": "string",
            "city": "string",
            "region": "string",
            "country": "string"
        },
        "legalInformation": {
            "taxIdType": "CUIL",
            "taxId": "string",
            "taxCondition": "VAT_REGISTERED",
            "category": "Consumidor final",
            "taxExempt": true
        },
        "account": {
            "ownerType": "USER",
            "uuid": "string",
            "status": "ACTIVE",
            "created": "2024-10-14T18:48:17.496156",
            "updated": "2024-10-14T18:48:17.496156",
            "cvu": "string",
            "alias": "string",
            "currency": "string",
            "balance": 1.0,
            "monthlyDepositOperation": 1.0,
            "monthlyWithdrawOperation": 1.0
        }
    }

  • 400 Bad Request –

    Invalid payload

    Ejemplo de respuesta:

    HTTP/1.1 400 Bad Request
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "items": [
                {
                    "path": "string",
                    "message": "string",
                    "type": "required"
                }
            ]
        }
    }

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

GET /users/all

Get all users

Petición de ejemplo:

GET /users/all HTTP/1.1
Host: example.com

• Status Codes:

  • 200 OK –

    List of users

    Ejemplo de respuesta:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    [
        {
            "uuid": "string",
            "firstName": "string",
            "lastName": "string",
            "birthday": "2024-10-14",
            "civilStatus": "single",
            "legalAddress": {
                "streetName": "string",
                "streetNumber": "string",
                "floor": "string",
                "apartment": "string",
                "zipCode": "string",
                "neighborhood": "string",
                "city": "string",
                "region": "string",
                "country": "string"
            },
            "account": {
                "ownerType": "USER",
                "uuid": "string",
                "status": "ACTIVE",
                "created": "2024-10-14T18:48:17.496156",
                "updated": "2024-10-14T18:48:17.496156",
                "cvu": "string",
                "alias": "string",
                "currency": "string",
                "balance": 1.0,
                "monthlyDepositOperation": 1.0,
                "monthlyWithdrawOperation": 1.0
            },
            "legalInformation": {
                "taxIdType": "CUIL",
                "taxId": "string",
                "taxCondition": "VAT_REGISTERED",
                "category": "Consumidor final",
                "taxExempt": true
            }
        }
    ]

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }

GET /users/[uuid]

Get user information

• Parameters:
  • uuid (string) –

Petición de ejemplo:

GET /users/[uuid] HTTP/1.1
Host: example.com

• Status Codes:

  • 200 OK –

    User details

    Ejemplo de respuesta:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "uuid": "string",
        "firstName": "string",
        "lastName": "string",
        "birthday": "2024-10-14",
        "civilStatus": "single",
        "legalAddress": {
            "streetName": "string",
            "streetNumber": "string",
            "floor": "string",
            "apartment": "string",
            "zipCode": "string",
            "neighborhood": "string",
            "city": "string",
            "region": "string",
            "country": "string"
        },
        "account": {
            "ownerType": "USER",
            "uuid": "string",
            "status": "ACTIVE",
            "created": "2024-10-14T18:48:17.496156",
            "updated": "2024-10-14T18:48:17.496156",
            "cvu": "string",
            "alias": "string",
            "currency": "string",
            "balance": 1.0,
            "monthlyDepositOperation": 1.0,
            "monthlyWithdrawOperation": 1.0
        },
        "legalInformation": {
            "taxIdType": "CUIL",
            "taxId": "string",
            "taxCondition": "VAT_REGISTERED",
            "category": "Consumidor final",
            "taxExempt": true
        }
    }

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }

PATCH /users/[uuid]

Modify user information

• Parameters:
  • uuid (string) –

Petición de ejemplo:

PATCH /users/[uuid] HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "birthday": "2024-10-14",
    "sex": "M",
    "legalName": "name@example.com",
    "taxId": "string",
    "nationality": "string"
}

• Status Codes:

  • 200 OK –

    User information updated

    Ejemplo de respuesta:

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "uuid": "string",
        "firstName": "string",
        "lastName": "string",
        "birthday": "2024-10-14",
        "civilStatus": "single",
        "legalAddress": {
            "streetName": "string",
            "streetNumber": "string",
            "floor": "string",
            "apartment": "string",
            "zipCode": "string",
            "neighborhood": "string",
            "city": "string",
            "region": "string",
            "country": "string"
        },
        "account": {
            "ownerType": "USER",
            "uuid": "string",
            "status": "ACTIVE",
            "created": "2024-10-14T18:48:17.496156",
            "updated": "2024-10-14T18:48:17.496156",
            "cvu": "string",
            "alias": "string",
            "currency": "string",
            "balance": 1.0,
            "monthlyDepositOperation": 1.0,
            "monthlyWithdrawOperation": 1.0
        },
        "legalInformation": {
            "taxIdType": "CUIL",
            "taxId": "string",
            "taxCondition": "VAT_REGISTERED",
            "category": "Consumidor final",
            "taxExempt": true
        }
    }

  • 400 Bad Request –

    Invalid payload

    Ejemplo de respuesta:

    HTTP/1.1 400 Bad Request
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "items": [
                {
                    "path": "string",
                    "message": "string",
                    "type": "required"
                }
            ]
        }
    }

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }

DELETE /users/[uuid]

Delete user

• Parameters:

  • uuid (string) –

• Status Codes:

  • 204 No Content – User deleted

  • 401 Unauthorized –

    Unauthorized

    Ejemplo de respuesta:

    HTTP/1.1 401 Unauthorized
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string"
    }

  • 404 Not Found –

    User not found

    Ejemplo de respuesta:

    HTTP/1.1 404 Not Found
    Content-Type: application/json
    
    {
        "name": "string",
        "message": "string",
        "detail": {
            "item": "string"
        }
    }