XRay.ClientV2 0.0.29

XRay

Package for testing and using XRay KYC/B services.

Before you start using this package, you will need to register your organisation at XRay Portal, and obtain your unique Token.

Usage info

To use XRayApiClient you will need to provide it with url endpoint and Token. Token is secret key generated on portal and is unique to your organisation.

To use APIs you first need to authenticate client using AuthenticateWithAsync method. It will use provided token to get XRay's access token - which lasts for a short period of time - usually 30min. After token expires, authenticate again with the same Token.

After authentication, you can use XRayApiClient to create and retrieve sessions.
Set isTesting = true on session to use test data that is not billed.

Example

Creating session

Returned session will be populated only with small subset of data - to get details, use GetSessionDetails()

static async Task<Session> CreateTestSession_PersonPasses()
        {
            using var client = new XRayApiClient(Endpoint);
            await client.AuthenticateWithAsync(Token);
            Session session;

            try
            {
                session = await client
                    .SetPerson(new PersonInput()
                    {
                        FirstName = "John",
                        MiddleName = "Henry",
                        LastName = "Smith",
                        Gender = "male",
                        IsoLatin1Name = "Johnny",
                        Nationality = "AU",
                        Dob = DateTime.Parse("2000-03-03"),
                        Documents = new List<DocumentInput>() {
                            new DocumentInput { Number = "B23SDS2233", Expiry = DateTime.Parse("2022-03-03"), Type = DocumentType.MediCard }
                        },
                        Communications = new List<CommunicationInput>() {
                            new CommunicationInput { IpAddress = "22.22.22.22", Website = "www.johnsmith.com" }
                        },
                    })
                    .SetIsTesting(true)
                    .SetResponseTransport(ResponseTransport.LongPolling)
                    //.SetWebhook("https://en4f7tfoezabp.x.pipedream.net/")
                    .SetDescription("Test from code: " + DateTime.Now.ToString())
                    .SetConfigurationId(ConfigurationId)
                    .PublishAsync();
            }
            catch (ResponseException resExc)
            {
                Console.WriteLine(resExc.Message);
                Console.WriteLine(String.Join("\n", resExc.AllErrorMessages));
                return null;
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
                return null;
            }

            // Now get all details about session
            return await GetSessionDetails(session.Id ?? Guid.Empty, client);
        }

Get Session details

        static async Task<Session> GetSessionDetails(Guid id, XRayApiClient client)
        {
            try
            {
                var session = await client.GetSessionAsync(id);
                Console.WriteLine(JsonSerializer.Serialize(session, new JsonSerializerOptions { WriteIndented = true }));

                return session;
            }
            catch (ResponseException resExc)
            {
                Console.WriteLine(resExc.Message);
                Console.WriteLine(String.Join("\n", resExc.AllErrorMessages));
                return null;
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
                return null;
            }
        }