# identity/odis/query

## Index

### Enumerations

* [AuthenticationMethod](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [ErrorMessages](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)

### Interfaces

* [CustomSigner](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/_identity_odis_query_.customsigner)
* [EncryptionKeySigner](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [MatchmakingRequest](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [MatchmakingResponse](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [PhoneNumberPrivacyRequest](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [ServiceContext](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [SignMessageRequest](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [SignMessageResponse](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)
* [WalletKeySigner](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)

### Type aliases

* [AuthSigner](#authsigner)

### Functions

* [getServiceContext](#getservicecontext)
* [queryOdis](#queryodis)

### Object literals

* [ODIS\_ALFAJORESSTAGING\_CONTEXT](#const-odis_alfajoresstaging_context)
* [ODIS\_ALFAJORES\_CONTEXT](#const-odis_alfajores_context)
* [ODIS\_MAINNET\_CONTEXT](#const-odis_mainnet_context)

## Type aliases

### AuthSigner

Ƭ **AuthSigner**: [*WalletKeySigner*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference) *|* [*EncryptionKeySigner*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference) *|* [*CustomSigner*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/_identity_odis_query_.customsigner)

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:29*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L29)

## Functions

### getServiceContext

▸ **getServiceContext**(`contextName`: string): [*ServiceContext*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:97*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L97)

**Parameters:**

| Name          | Type   | Default   |
| ------------- | ------ | --------- |
| `contextName` | string | "mainnet" |

**Returns:** [*ServiceContext*](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)

### queryOdis

▸ **queryOdis**<**ResponseType**>(`signer`: [AuthSigner](#authsigner), `body`: [PhoneNumberPrivacyRequest](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference), `context`: [ServiceContext](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference), `endpoint`: string): *Promise‹ResponseType›*

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:115*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L115)

Make a request to lookup the phone number identifier or perform matchmaking

**Type parameters:**

▪ **ResponseType**

**Parameters:**

| Name       | Type                                                                                                                       | Description              |
| ---------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| `signer`   | [AuthSigner](#authsigner)                                                                                                  | type of key to sign with |
| `body`     | [PhoneNumberPrivacyRequest](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference) | request body             |
| `context`  | [ServiceContext](https://josh-8.gitbook.io/celo-docs/developer-guide/summary/external-modules/broken-reference)            | contains service URL     |
| `endpoint` | string                                                                                                                     | endpoint to hit          |

**Returns:** *Promise‹ResponseType›*

## Object literals

### `Const` ODIS\_ALFAJORESSTAGING\_CONTEXT

### ▪ **ODIS\_ALFAJORESSTAGING\_CONTEXT**: *object*

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:85*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L85)

### odisPubKey

• **odisPubKey**: *string* = "7FsWGsFnmVvRfMDpzz95Np76wf/1sPaK0Og9yiB+P8QbjiC8FV67NBans9hzZEkBaQMhiapzgMR6CkZIZPvgwQboAxl65JWRZecGe5V3XO4sdKeNemdAZ2TzQuWkuZoA"

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:87*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L87)

### odisUrl

• **odisUrl**: *string* = "<https://us-central1-celo-phone-number-privacy-stg.cloudfunctions.net>"

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:86*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L86)

### `Const` ODIS\_ALFAJORES\_CONTEXT

### ▪ **ODIS\_ALFAJORES\_CONTEXT**: *object*

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:79*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L79)

### odisPubKey

• **odisPubKey**: *string* = "kPoRxWdEdZ/Nd3uQnp3FJFs54zuiS+ksqvOm9x8vY6KHPG8jrfqysvIRU0wtqYsBKA7SoAsICMBv8C/Fb2ZpDOqhSqvr/sZbZoHmQfvbqrzbtDIPvUIrHgRS0ydJCMsA"

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:81*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L81)

### odisUrl

• **odisUrl**: *string* = "<https://us-central1-celo-phone-number-privacy.cloudfunctions.net>"

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:80*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L80)

### `Const` ODIS\_MAINNET\_CONTEXT

### ▪ **ODIS\_MAINNET\_CONTEXT**: *object*

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:91*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L91)

### odisPubKey

• **odisPubKey**: *string* = "FvreHfLmhBjwxHxsxeyrcOLtSonC9j7K3WrS4QapYsQH6LdaDTaNGmnlQMfFY04Bp/K4wAvqQwO9/bqPVCKf8Ze8OZo8Frmog4JY4xAiwrsqOXxug11+htjEe1pj4uMA"

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:93*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L93)

### odisUrl

• **odisUrl**: *string* = "<https://us-central1-celo-pgpnp-mainnet.cloudfunctions.net>"

*Defined in* [*packages/contractkit/src/identity/odis/query.ts:92*](https://github.com/celo-org/celo-monorepo/blob/master/packages/contractkit/src/identity/odis/query.ts#L92)
