> This page is optimized for agents. Use the linked Markdown pages and llms.txt indexes for related API content.

# Verifies a guest verification request.

> Verifies a guest verification request, and returns either an error or the guest's information.

- Product: Guest verifications
- Section: Guest verification
- Snapshot: Current
- Method: `POST`
- Path: `/api/guest_verifications/verify`

## Query parameters

### `reservation`

Type: `number`  
Required: yes  

### `organization`

Type: `number`  
Required: yes  

### `token`

Type: `string`  
Required: yes  

## Request body

Required: yes  
Content types: `application/json`  

### `email`

Type: `string`  
Required: yes  

### `code`

Type: `string`  
Required: yes  

## Execute with TypeScript

Package: `@recranet/sdk`  

```ts
import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.guestVerifications.verify({
  reservation: 0,
  organization: 0,
  token: "<token>",
  email: "<email>",
  code: "<code>",
});
```

## Execute with curl

```bash
curl -X POST "https://app.recranet.com/api/guest_verifications/verify" \
    -H "X-Api-Key: $RECRANET_API_KEY" \
    --url-query "reservation=$RESERVATION" \
    --url-query "organization=$ORGANIZATION" \
    --url-query "token=$TOKEN" \
    -H 'Content-Type: application/json' \
    -d '{"email":"<email>","code":"<code>"}'
```

## Responses

### Response `200`

Category: success  

Successful response

#### `application/json`

##### Generated example

```json
{
  "id": 0,
  "code": "code",
  "expires": "expires",
  "email": "email",
  "verified": false,
  "locale": "locale",
  "type": "checkout",
  "guest": {
    "id": 0,
    "uuid": "uuid",
    "locale": "nl",
    "created": "created",
    "attachments": [
      {
        "id": 0,
        "type": "type",
        "locale": "locale",
        "name": "name",
        "filename": "filename",
        "url": "url"
      }
    ],
    "displayName": "displayName",
    "subscribed": true,
    "email": "email",
    "type": "type",
    "reference": "reference",
    "initials": "initials",
    "firstName": "firstName",
    "surname": "surname",
    "surnamePrefix": "surnamePrefix",
    "organizationName": "organizationName",
    "vatNumber": "vatNumber",
    "companyRegistrationNumber": "companyRegistrationNumber",
    "salutation": "salutation",
    "phoneNumber": "phoneNumber",
    "phoneNumberHome": "phoneNumberHome",
    "phoneNumberWork": "phoneNumberWork",
    "address": "address",
    "addressNo": "addressNo",
    "postalCode": "postalCode",
    "locality": "locality",
    "municipality": 0,
    "country": "NL",
    "birthDate": "birthDate",
    "birthPlace": "birthPlace",
    "membership": "membership",
    "registrationNumbers": [],
    "accessCardNumber": "accessCardNumber",
    "iban": "iban",
    "ibanAccountName": "ibanAccountName",
    "bic": "bic",
    "notes": "notes",
    "customFields": {},
    "verified": false,
    "subscribedToNewsletter": false,
    "subscribedToInformativeMessages": false,
    "returning": false,
    "source": "source",
    "sourceOther": "sourceOther",
    "documentType": "documentType",
    "documentNumber": "documentNumber",
    "roles": [],
    "modified": "modified"
  }
}
```

##### Schema

###### GuestVerification

Type: `GuestVerification`  

###### `id`

Type: `number`  
Required: yes  

###### `email`

Type: `string`  
Required: no  

###### `code`

Type: `string`  
Required: yes  

###### `verified`

Type: `boolean`  
Required: no  
Default: `false`  

###### `locale`

Type: `string`  
Required: no  

###### `type`

Type: `string`  
Required: no  
Default: `checkout`  

###### `expires`

Type: `string`  
Format: `date-time`  
Required: yes  

###### `guest`

Type: `Guest`  
Required: no  

###### Guest

Type: `Guest`  

###### `id`

Type: `number`  
Required: yes  

###### `uuid`

Type: `string`  
Required: yes  

###### `email`

Type: `string`  
Required: no  

###### `type`

Type: `string`  
Required: no  

###### `reference`

Type: `string`  
Required: no  

###### `initials`

Type: `string`  
Required: no  

###### `firstName`

Type: `string`  
Required: no  

###### `surname`

Type: `string`  
Required: no  

###### `surnamePrefix`

Type: `string`  
Required: no  

###### `organizationName`

Type: `string`  
Required: no  

###### `vatNumber`

Type: `string`  
Required: no  

###### `companyRegistrationNumber`

Type: `string`  
Required: no  

###### `salutation`

Type: `string`  
Required: no  

###### `phoneNumber`

Type: `string`  
Required: no  

###### `phoneNumberHome`

Type: `string`  
Required: no  

###### `phoneNumberWork`

Type: `string`  
Required: no  

###### `address`

Type: `string`  
Required: no  

###### `addressNo`

Type: `string`  
Required: no  

###### `postalCode`

Type: `string`  
Required: no  

###### `locality`

Type: `string`  
Required: no  

###### `municipality`

Type: `number`  
Required: no  

###### `country`

Type: `string`  
Required: no  

###### `locale`

Type: `string`  
Required: yes  

###### `birthDate`

Type: `string`  
Format: `date-time`  
Required: no  

###### `birthPlace`

Type: `string`  
Required: no  

###### `membership`

Type: `string`  
Required: no  

###### `registrationNumbers`

Type: `string[]`  
Required: no  

###### string

Type: `string`  

###### `accessCardNumber`

Type: `string`  
Required: no  

###### `iban`

Type: `string`  
Required: no  

###### `ibanAccountName`

Type: `string`  
Required: no  

###### `bic`

Type: `string`  
Required: no  

###### `notes`

Type: `string`  
Required: no  

###### `customFields`

Type: `object`  
Required: no  

###### `verified`

Type: `boolean`  
Required: no  
Default: `false`  

###### `subscribedToNewsletter`

Type: `boolean`  
Required: no  
Default: `false`  

Indicates whether the guest would like to receive the newsletter

###### `subscribedToInformativeMessages`

Type: `boolean`  
Required: no  
Default: `false`  

Indicates whether the guest would like to receive informative messages

###### `returning`

Type: `boolean`  
Required: no  
Default: `false`  

###### `source`

Type: `string`  
Required: no  

###### `sourceOther`

Type: `string`  
Required: no  

###### `documentType`

Type: `string`  
Required: no  

###### `documentNumber`

Type: `string`  
Required: no  

###### `roles`

Type: `string[]`  
Required: no  

###### string

Type: `string`  

###### `created`

Type: `string`  
Format: `date-time`  
Required: yes  

###### `modified`

Type: `string`  
Format: `date-time`  
Required: no  

###### `attachments`

Type: `GuestAttachment[]`  
Required: yes  

###### GuestAttachment

Type: `GuestAttachment`  

###### `id`

Type: `number`  
Required: yes  

###### `name`

Type: `string`  
Required: no  

###### `filename`

Type: `string`  
Required: no  

###### `url`

Type: `string`  
Required: no  

###### `type`

Type: `string`  
Required: yes  

###### `locale`

Type: `string`  
Required: yes  

###### `displayName`

Type: `string`  
Required: yes  

###### `subscribed`

Type: `boolean`  
Required: yes  
Deprecated: yes  

use subscribedToNewsletter instead

### Response `400`

Category: client-error  

Bad request

#### `application/json`

##### Example

```json
{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}
```

##### Schema

###### object

Type: `object`  

### Response `404`

Category: client-error  

Not found

#### `application/json`

##### Example

```json
{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}
```

##### Schema

###### object

Type: `object`  

## Related representations

- [Human documentation](/guest-verifications/methods/verify/)
- [TypeScript Markdown](/guest-verifications/methods/verify.md?lang=typescript)
- [curl Markdown](/guest-verifications/methods/verify.md?lang=curl)
- [site llms.txt](/llms.txt)
- [product llms.txt](/guest-verifications/llms.txt)
- [snapshot llms.txt](/guest-verifications/llms.txt)
