> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify visa

> This endpoint verifies a visa against official records using the holder's personal details and passport information. It returns field-by-field match results for each submitted detail.

### Headers

**X-API-Version** `string` *required* (default: 1.2)

The API version to use. Supported versions are `1.1` and `1.2`.

### Request Body Parameters

**birth\_date** `string` *required*

Date of birth of the visa holder. Format: YYYY-MM-DD.

**given\_name** `string` *required*

The first name of the visa holder.

**family\_name** `string` *required*

The last name of the visa holder.

**passport\_number** `string` *required*

The passport number associated with the visa.

**country\_of\_issue** `string` *required*

The 3-letter ISO country code where the passport was issued (e.g. "CAN", "GBR", "USA").

### Response Body

| Field | Type | Description |
| - | - | - |
| `message` | string | A message describing the response status (e.g. "Verification Result"). |
| `data`object | object | The visa verification result data. |
| ↳`documentResult` | object | Contains the overall verification result including ActivityId, OriginatingAgencyCode, VerificationRequestNumber, and VerificationResultCode ("Y" for verified, "N" for not verified). |
| ↳`documentDetails` | object | Field-by-field match results. Each field (GivenName, FamilyName, BirthDate, PassportNumber, CountryOfIssue, etc.) will have a value of "Full Match", "Partial Match", or "No Match". |
| ↳`status` | string | Overall verification status. "Y" indicates the visa is verified, "N" indicates it is not verified. |

### Response Codes

| Code | Description |
| - | - |
| 200 | The visa was successfully verified and the match results are returned. |
| 400 | Bad Request. Missing or invalid parameters. |
| 401 | Unauthorized. Missing or invalid credentials. |
| 500 | Internal Server Error. |

```bash cURL theme={null}
curl -X POST https://qa-payments.mygigsters.com.au/api/v1/verify/visa \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json" \
  -d '{
  "birth_date": "1992-06-18",
  "given_name": "John",
  "family_name": "Smith",
  "passport_number": "DW126813",
  "country_of_issue": "CAN"
}'
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/verify/visa", {
  method: "POST",
  headers: {
    Authorization: "Basic " + Buffer.from("YOUR_UUID:YOUR_SECRET").toString("base64"),
    "X-API-Version": "1.2",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "birth_date": "1992-06-18",
    "given_name": "John",
    "family_name": "Smith",
    "passport_number": "DW126813",
    "country_of_issue": "CAN"
  }),
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.post(
    "https://qa-payments.mygigsters.com.au/api/v1/verify/visa",
    auth=("YOUR_UUID", "YOUR_SECRET"),
    headers={
        "X-API-Version": "1.2",
    },
    json={
        "birth_date": "1992-06-18",
        "given_name": "John",
        "family_name": "Smith",
        "passport_number": "DW126813",
        "country_of_issue": "CAN",
    },
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/verify/visa")
request = Net::HTTP::Post.new(uri)
request.basic_auth("YOUR_UUID", "YOUR_SECRET")
request["X-API-Version"] = "1.2"
request["Content-Type"] = "application/json"
request.body = <<~JSON
  {
    "birth_date": "1992-06-18",
    "given_name": "John",
    "family_name": "Smith",
    "passport_number": "DW126813",
    "country_of_issue": "CAN"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/verify/visa");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_USERPWD => "YOUR_UUID:YOUR_SECRET",
    CURLOPT_HTTPHEADER => [
        "X-API-Version: 1.2",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "birth_date": "1992-06-18",
  "given_name": "John",
  "family_name": "Smith",
  "passport_number": "DW126813",
  "country_of_issue": "CAN"
}
JSON,
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Example {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString("YOUR_UUID:YOUR_SECRET".getBytes());

        String body = String.join("\n",
            "{",
            "  \"birth_date\": \"1992-06-18\",",
            "  \"given_name\": \"John\",",
            "  \"family_name\": \"Smith\",",
            "  \"passport_number\": \"DW126813\",",
            "  \"country_of_issue\": \"CAN\"",
            "}"
        );

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/verify/visa"))
            .header("Authorization", "Basic " + credentials)
            .header("X-API-Version", "1.2")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "birth_date": "1992-06-18",
  "given_name": "John",
  "family_name": "Smith",
  "passport_number": "DW126813",
  "country_of_issue": "CAN"
}`)

	req, err := http.NewRequest("POST", "https://qa-payments.mygigsters.com.au/api/v1/verify/visa", body)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("YOUR_UUID", "YOUR_SECRET")
	req.Header.Set("X-API-Version", "1.2")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://qa-payments.mygigsters.com.au/api/v1/verify/visa");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("YOUR_UUID:YOUR_SECRET")));
request.Headers.Add("X-API-Version", "1.2");
request.Content = new StringContent(@"{
  ""birth_date"": ""1992-06-18"",
  ""given_name"": ""John"",
  ""family_name"": ""Smith"",
  ""passport_number"": ""DW126813"",
  ""country_of_issue"": ""CAN""
}", Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json Response theme={null}
{
  "message": "Verification Result",
  "data": {
    "documentResult": {
      "attributes": {
        "i:type": "VisaResponse"
      },
      "ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "OriginatingAgencyCode": "XXXX",
      "VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "VerificationResultCode": "Y"
    },
    "documentDetails": {
      "BirthDate": "Full Match",
      "BirthDay": "Full Match",
      "BirthMonth": "Full Match",
      "BirthYear": "Full Match",
      "GivenName": "Full Match",
      "FamilyName": "Full Match",
      "PassportNumber": "Full Match",
      "CountryOfIssue": "Full Match",
      "RegistrationState": "Full Match"
    },
    "status": "Y"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.